Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Add a Custom CommandAdd a Custom Command
Expand Add an Add-inAdd an Add-in
Expand Release NotesRelease Notes
Expand SampleSample
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
Collapse IDispatchIDispatch
IEwAPIX
IEwAddIn
IEwAddinInternalX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCaptionBarControlX
IEwCaptionBarX
IEwClassificationManagerX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwDocumentManagerX
IEwDocumentX
IEwEnvironmentX
IEwLibraryManagerX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwMenuItemX
IEwMenuManagerX
IEwMenuX
IEwNotificationDialogX
Expand IEwObjectDispatchXIEwObjectDispatchX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileConfigurationManagerX
IEwProjectFileConfigurationX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectMultilingualTextFontX
IEwProjectMultilingualTextManagerX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectWireStyleManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonComboBoxControlX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonQuickAccessControlX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSaveDWGImageX
IEwSelectorDialogX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwTerminalTypeManagerX
IEwTitleBlockManagerX
IEwWireTerminationTypeManagerX
IEwXLSBookX
IEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand PDM Pro API Web ServicePDM Pro API Web Service
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Inspection API HelpSOLIDWORKS Inspection API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
Public Member Functions | List of all members
IEwSymbolFiltersX Interface Reference

Use this interface to manage filter for EwSymbolX. More...

Inheritance diagram for IEwSymbolFiltersX:
Inheritance graph

Public Member Functions

LONG getClassNodeID ()
 Get the class ID of the filter. More...
 
void setClassNodeID (LONG lNodeID)
 Set/reset the class ID of the filter. More...
 
EwSymbolType getEwSymbolType ()
 Get the symbol type of the filter. More...
 
void setEwSymbolType (EwSymbolType eSymbolTypes)
 Set/reset the symbol type of the filter. More...
 
BSTR getSymbolName ()
 Get the symbol name of the filter. More...
 
void setSymbolName (BSTR strName)
 Set/reset the symbol name of the filter. More...
 
BSTR getDescription (BSTR lgCode, EwErrorCode *errorCode)
 Get the description of the filter. More...
 
EwErrorCode setDescription (BSTR lgCode, BSTR val)
 Set/reset the description of the filter. More...
 
EwMeasurementType getEwMeasurementType ()
 Get the measurement of the filter. More...
 
void setEwMeasurementType (EwMeasurementType eMeasurementTypes)
 Set/reset the measurement of the filter. More...
 
BSTR getLibraryCode ()
 Get the library code of the filter. More...
 
void setLibraryCode (BSTR strLibraryCode)
 Set/reset the library code of the filter. More...
 
BSTR getManufacturer ()
 Get the manufacturer of the filter. More...
 
void setManufacturer (BSTR strManufacturer)
 Set/reset the manufacturer of the filter. More...
 
BSTR getReference ()
 Get the reference of the filter. More...
 
void setReference (BSTR strReference)
 Set/reset the reference of the filter. More...
 
DATE getModificationDateFrom ()
 Get the modification date from of the filter. More...
 
void setModificationDateFrom (DATE modificationDateFrom)
 Set/reset the modification date from of the filter. More...
 
DATE getModificationDateTo ()
 Get the "modification date to" of the filter. More...
 
void setModificationDateTo (DATE modificationDateTo)
 Set/reset the "modification date to" of the filter. More...
 
DATE getCreationDateFrom ()
 Get the "creation date from" of the filter. More...
 
void setCreationDateFrom (DATE creationDateFrom)
 Set/reset the "creation date from" of the filter. More...
 
DATE getCreationDateTo ()
 Get the "creation date to" of the filter. More...
 
void setCreationDateTo (DATE creationDateTo)
 Set/reset the "creation date to" of the filter. More...
 
LONG getEwSymbolCircuitCount ()
 Get the number of circuit of the filter. More...
 
void setEwSymbolCircuitCount (LONG lNbCircuit)
 Set/reset the number of circuit of the filter. More...
 
LONG getEwSymbolPointCount ()
 Get the number of connection point of the filter. More...
 
void setEwSymbolPointCount (LONG lConnectionPoint)
 Set/reset the number of connection point of the filter. More...
 
BSTR getRootMark ()
 Get the root mark of the filter. More...
 
void setRootMark (BSTR strRootMark)
 Set/reset the root mark of the filter. More...
 
BSTR getAssociatedMacro ()
 Get the associated macro of the filter. More...
 
void setAssociatedMacro (BSTR strAssociatedMacro)
 Set/reset the associated macro of the filter. More...
 
EwSymbolCrossRefType getEwSymbolCrossRefType ()
 Get the type of cross reference of the filter. More...
 
void setEwSymbolCrossRefType (EwSymbolCrossRefType eSymbolCrossRefTypes)
 Set/reset the type of cross reference of the filter. More...
 
EwBooleanFiltersValue getDisplayEwSymbolPoint ()
 Get the display connection point value of the filter. More...
 
void setDisplayEwSymbolPoint (EwBooleanFiltersValue eBooleanFiltersValues)
 Set the display connection point value of the filter. More...
 
EwBooleanFiltersValue getDoNotRotateAttributes ()
 Get the value of "do not rotate attributes" of the filter. More...
 
void setDoNotRotateAttributes (EwBooleanFiltersValue eBooleanFiltersValue)
 Set the value of "do not rotate attributes" of the filter. More...
 
EwErrorCode getEwSymbolArray (VARIANT *vArray)
 Return Array of Symbol according to filter. More...
 
BSTR getTerminalStripDrawingSymbol ()
 Get the TerminalStrip drawing symbol of the filter. More...
 
void setTerminalStripDrawingSymbol (BSTR strTerminalStripDrawingSymbol)
 Set/reset the TerminalStrip drawing symbol of the filter. More...
 

Detailed Description

Use this interface to manage filter for EwSymbolX.

Since
2018 SP0

Member Function Documentation

◆ getAssociatedMacro()

BSTR IEwSymbolFiltersX::getAssociatedMacro ( )

Get the associated macro of the filter.

Returns
The associated macro or an empty string if filter isn't active

◆ getClassNodeID()

LONG IEwSymbolFiltersX::getClassNodeID ( )

Get the class ID of the filter.

Returns
The class ID or -LONG_MIN (-2147483647) if filter isn't active

◆ getCreationDateFrom()

DATE IEwSymbolFiltersX::getCreationDateFrom ( )

Get the "creation date from" of the filter.

Returns
The "creation date from" date to or 0 if filter isn't active

◆ getCreationDateTo()

DATE IEwSymbolFiltersX::getCreationDateTo ( )

Get the "creation date to" of the filter.

Returns
The "creation date to" or 0 if filter isn't active

◆ getDescription()

BSTR IEwSymbolFiltersX::getDescription ( BSTR  lgCode,
EwErrorCode *  errorCode 
)

Get the description of the filter.

Parameters
[in]lgCodelgCode The language of the description you want to get (like 'en' for english or 'fr' for french )
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if lgCode is not valid
Returns
The symbol name or an empty string if filter isn't active

◆ getDisplayEwSymbolPoint()

EwBooleanFiltersValue IEwSymbolFiltersX::getDisplayEwSymbolPoint ( )

Get the display connection point value of the filter.

Returns
The display connection point value

◆ getDoNotRotateAttributes()

EwBooleanFiltersValue IEwSymbolFiltersX::getDoNotRotateAttributes ( )

Get the value of "do not rotate attributes" of the filter.

Returns
The value of "do not rotate attributes".

◆ getEwMeasurementType()

EwMeasurementType IEwSymbolFiltersX::getEwMeasurementType ( )

Get the measurement of the filter.

Returns
The measurement or an EwMeasurementType::kMeasurementTypeUnknown if filter isn't active

◆ getEwSymbolArray()

EwErrorCode IEwSymbolFiltersX::getEwSymbolArray ( VARIANT *  vArray)

Return Array of Symbol according to filter.

Since
2018 SP3
Parameters
[out]vArrayArray of symbol according to filter
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if filters is not good

◆ getEwSymbolCircuitCount()

LONG IEwSymbolFiltersX::getEwSymbolCircuitCount ( )

Get the number of circuit of the filter.

Returns
The number of circuit or -1 if filter isn't active

◆ getEwSymbolCrossRefType()

EwSymbolCrossRefType IEwSymbolFiltersX::getEwSymbolCrossRefType ( )

Get the type of cross reference of the filter.

Returns
The type of cross reference or SymbolCrossRefTypes::kSymbolCrossRefUndefined if filter isn't active

◆ getEwSymbolPointCount()

LONG IEwSymbolFiltersX::getEwSymbolPointCount ( )

Get the number of connection point of the filter.

Returns
The number of connection point or -1 if filter isn't active

◆ getEwSymbolType()

EwSymbolType IEwSymbolFiltersX::getEwSymbolType ( )

Get the symbol type of the filter.

Returns
The symbol type or EwSymbolType::kSymbolUndefined if filter isn't active

◆ getLibraryCode()

BSTR IEwSymbolFiltersX::getLibraryCode ( )

Get the library code of the filter.

Returns
The library code or an empty string if filter isn't active

◆ getManufacturer()

BSTR IEwSymbolFiltersX::getManufacturer ( )

Get the manufacturer of the filter.

Returns
The manufacturer or an empty string if filter isn't active

◆ getModificationDateFrom()

DATE IEwSymbolFiltersX::getModificationDateFrom ( )

Get the modification date from of the filter.

Returns
The modification date from or 0 if filter isn't active

◆ getModificationDateTo()

DATE IEwSymbolFiltersX::getModificationDateTo ( )

Get the "modification date to" of the filter.

Returns
The "modification date to" or an 0 if filter isn't active

◆ getReference()

BSTR IEwSymbolFiltersX::getReference ( )

Get the reference of the filter.

Returns
The reference or an empty string if filter isn't active

◆ getRootMark()

BSTR IEwSymbolFiltersX::getRootMark ( )

Get the root mark of the filter.

Returns
The root mark or an empty string if filter isn't active

◆ getSymbolName()

BSTR IEwSymbolFiltersX::getSymbolName ( )

Get the symbol name of the filter.

Returns
The symbol name or an empty string if filter isn't active

◆ getTerminalStripDrawingSymbol()

BSTR IEwSymbolFiltersX::getTerminalStripDrawingSymbol ( )

Get the TerminalStrip drawing symbol of the filter.

Returns
TerminalStrip drawing symbol or an empty string if filter isn't active

◆ setAssociatedMacro()

void IEwSymbolFiltersX::setAssociatedMacro ( BSTR  strAssociatedMacro)

Set/reset the associated macro of the filter.

Parameters
[in]strAssociatedMacroThe associated macro you want to set. To disable the filter use an empty string.

◆ setClassNodeID()

void IEwSymbolFiltersX::setClassNodeID ( LONG  lNodeID)

Set/reset the class ID of the filter.

Parameters
[in]lNodeIDThe class ID you want to set. To disable the filter use the value -LONG_MIN (-2147483647)

◆ setCreationDateFrom()

void IEwSymbolFiltersX::setCreationDateFrom ( DATE  creationDateFrom)

Set/reset the "creation date from" of the filter.

Parameters
[in]creationDateFromThe "creation date from" you want to set. To disable the filter use 0.

◆ setCreationDateTo()

void IEwSymbolFiltersX::setCreationDateTo ( DATE  creationDateTo)

Set/reset the "creation date to" of the filter.

Parameters
[in]creationDateToThe "creation date to" you want to set. To disable the filter use 0.

◆ setDescription()

EwErrorCode IEwSymbolFiltersX::setDescription ( BSTR  lgCode,
BSTR  val 
)

Set/reset the description of the filter.

Parameters
[in]lgCodelgCode The language of the description you want to get (like 'en' for english or 'fr' for french )
[in]valThe description you want to set. To disable the filter use an empty string.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if lgCode is not valid

◆ setDisplayEwSymbolPoint()

void IEwSymbolFiltersX::setDisplayEwSymbolPoint ( EwBooleanFiltersValue  eBooleanFiltersValues)

Set the display connection point value of the filter.

Parameters
[in]eBooleanFiltersValuesThe display connection point value you want to set.

◆ setDoNotRotateAttributes()

void IEwSymbolFiltersX::setDoNotRotateAttributes ( EwBooleanFiltersValue  eBooleanFiltersValue)

Set the value of "do not rotate attributes" of the filter.

Parameters
[in]eBooleanFiltersValueThe value of "do not rotate attributes" you want to set.

◆ setEwMeasurementType()

void IEwSymbolFiltersX::setEwMeasurementType ( EwMeasurementType  eMeasurementTypes)

Set/reset the measurement of the filter.

Parameters
[in]eMeasurementTypesThe measurement you want to set. To disable the filter use EwMeasurementType::kMeasurementTypeUnknown.

◆ setEwSymbolCircuitCount()

void IEwSymbolFiltersX::setEwSymbolCircuitCount ( LONG  lNbCircuit)

Set/reset the number of circuit of the filter.

Parameters
[in]lNbCircuitThe number of circuit you want to set. To disable the filter use -1.

◆ setEwSymbolCrossRefType()

void IEwSymbolFiltersX::setEwSymbolCrossRefType ( EwSymbolCrossRefType  eSymbolCrossRefTypes)

Set/reset the type of cross reference of the filter.

Parameters
[in]eSymbolCrossRefTypesThe type of cross reference you want to set. To disable the filter use SymbolCrossRefTypes::kSymbolCrossRefUndefined.

◆ setEwSymbolPointCount()

void IEwSymbolFiltersX::setEwSymbolPointCount ( LONG  lConnectionPoint)

Set/reset the number of connection point of the filter.

Parameters
[in]lConnectionPointThe number of connection point you want to set. To disable the filter use -1.

◆ setEwSymbolType()

void IEwSymbolFiltersX::setEwSymbolType ( EwSymbolType  eSymbolTypes)

Set/reset the symbol type of the filter.

Parameters
[in]eSymbolTypesThe symbol type you want to set. To disable the filter use the value EwSymbolType::kSymbolUndefined.

◆ setLibraryCode()

void IEwSymbolFiltersX::setLibraryCode ( BSTR  strLibraryCode)

Set/reset the library code of the filter.

Parameters
[in]strLibraryCodeThe library code you want to set. To disable the filter use an empty string.

◆ setManufacturer()

void IEwSymbolFiltersX::setManufacturer ( BSTR  strManufacturer)

Set/reset the manufacturer of the filter.

Parameters
[in]strManufacturerThe manufacturer you want to set. To disable the filter use an empty string.

◆ setModificationDateFrom()

void IEwSymbolFiltersX::setModificationDateFrom ( DATE  modificationDateFrom)

Set/reset the modification date from of the filter.

Parameters
[in]modificationDateFromThe modification date from you want to set. To disable the filter use 0.

◆ setModificationDateTo()

void IEwSymbolFiltersX::setModificationDateTo ( DATE  modificationDateTo)

Set/reset the "modification date to" of the filter.

Parameters
[in]modificationDateToThe "modification date to" you want to set. To disable the filter use 0.

◆ setReference()

void IEwSymbolFiltersX::setReference ( BSTR  strReference)

Set/reset the reference of the filter.

Parameters
[in]strReferenceThe reference you want to set. To disable the filter use an empty string.

◆ setRootMark()

void IEwSymbolFiltersX::setRootMark ( BSTR  strRootMark)

Set/reset the root mark of the filter.

Parameters
[in]strRootMarkThe root mark you want to set. To disable the filter use an empty string.

◆ setSymbolName()

void IEwSymbolFiltersX::setSymbolName ( BSTR  strName)

Set/reset the symbol name of the filter.

Parameters
[in]strNameThe symbol name you want to set. To disable the filter use an empty string.

◆ setTerminalStripDrawingSymbol()

void IEwSymbolFiltersX::setTerminalStripDrawingSymbol ( BSTR  strTerminalStripDrawingSymbol)

Set/reset the TerminalStrip drawing symbol of the filter.

Parameters
[in]strTerminalStripDrawingSymbolTerminalStrip drawing symbol you want to set. To disable the filter use an empty string.
Generated on Mon Aug 28 2023 13:39:21 for SOLIDWORKS Electrical API by doxygen 1.9.4


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SOLIDWORKS Electrical API: IEwSymbolFiltersX Interface Reference
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:
x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2024 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.

10.20.4