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
Collapse Class ListClass List
Expand IEwAddInIEwAddIn
IEwAddinInternalX
Expand IEwAPIXIEwAPIX
Expand IEwApplicationSettingsXIEwApplicationSettingsX
Expand IEwApplicationXIEwApplicationX
Expand IEwArchiveEnvironmentXIEwArchiveEnvironmentX
Expand IEwCableCoreXIEwCableCoreX
Expand IEwCableReferenceManagerXIEwCableReferenceManagerX
Expand IEwCableReferenceXIEwCableReferenceX
Expand IEwCaptionBarControlXIEwCaptionBarControlX
Expand IEwCaptionBarXIEwCaptionBarX
Expand IEwClassificationManagerXIEwClassificationManagerX
Expand IEwClassificationXIEwClassificationX
Expand IEwClassXIEwClassX
IEwCommandContextX
Expand IEwCommandManagerXIEwCommandManagerX
Expand IEwCommandXIEwCommandX
Expand IEwDialogAlignPartsParametersSelectorXIEwDialogAlignPartsParametersSelectorX
Expand IEwDialogLocationSelectorXIEwDialogLocationSelectorX
Expand IEwDialogMacroSelectorXIEwDialogMacroSelectorX
Expand IEwDialogManufacturerPartOrderingXIEwDialogManufacturerPartOrderingX
Expand IEwDialogManufacturerPartSelectorXIEwDialogManufacturerPartSelectorX
Expand IEwDialogProgressXIEwDialogProgressX
Expand IEwDialogProjectManagerXIEwDialogProjectManagerX
Expand IEwDialogResumeXIEwDialogResumeX
Expand IEwDialogSummaryXIEwDialogSummaryX
Expand IEwDialogTaskXIEwDialogTaskX
Expand IEwDockingPaneManagerXIEwDockingPaneManagerX
Expand IEwDockingPaneXIEwDockingPaneX
Expand IEwDocumentManagerXIEwDocumentManagerX
Expand IEwDocumentXIEwDocumentX
Expand IEwEnvironmentObjectXIEwEnvironmentObjectX
Expand IEwEnvironmentXIEwEnvironmentX
Expand IEwEXCELImportLibraryXIEwEXCELImportLibraryX
IEwInteropFactoryX
Expand IEwLibraryManagerXIEwLibraryManagerX
Expand IEwLibraryXIEwLibraryX
Expand IEwLockStringXIEwLockStringX
Expand IEwManagerDialogXIEwManagerDialogX
Expand IEwManufacturerPartCircuitXIEwManufacturerPartCircuitX
Expand IEwManufacturerPartManagerXIEwManufacturerPartManagerX
Expand IEwManufacturerPartTerminalXIEwManufacturerPartTerminalX
Expand IEwManufacturerPartXIEwManufacturerPartX
Expand IEwMenuItemXIEwMenuItemX
Expand IEwMenuManagerXIEwMenuManagerX
Expand IEwMenuXIEwMenuX
Expand IEwNotificationDialogXIEwNotificationDialogX
Expand IEwObjectBaseXIEwObjectBaseX
IEwObjectDispatchX
Expand IEwObjectXIEwObjectX
Expand IEwPointXIEwPointX
Expand IEwProjectAutomaticArrowsXIEwProjectAutomaticArrowsX
Expand IEwProjectBookManagerXIEwProjectBookManagerX
Expand IEwProjectBookXIEwProjectBookX
Expand IEwProjectCableManagerXIEwProjectCableManagerX
Expand IEwProjectCableXIEwProjectCableX
Expand IEwProjectComponentCircuitXIEwProjectComponentCircuitX
Expand IEwProjectComponentManagerXIEwProjectComponentManagerX
Expand IEwProjectComponentTerminalXIEwProjectComponentTerminalX
Expand IEwProjectComponentXIEwProjectComponentX
Expand IEwProjectConfigurationXIEwProjectConfigurationX
Expand IEwProjectEntity3DManagerXIEwProjectEntity3DManagerX
Expand IEwProjectEntity3DXIEwProjectEntity3DX
Expand IEwProjectExcelAutomationXIEwProjectExcelAutomationX
Expand IEwProjectExportDWGFilesXIEwProjectExportDWGFilesX
Expand IEwProjectExportPDFXIEwProjectExportPDFX
Expand IEwProjectExportPDMXIEwProjectExportPDMX
Expand IEwProjectExportReportXIEwProjectExportReportX
Expand IEwProjectFileConfigurationManagerXIEwProjectFileConfigurationManagerX
Expand IEwProjectFileConfigurationXIEwProjectFileConfigurationX
Expand IEwProjectFileManagerXIEwProjectFileManagerX
Expand IEwProjectFileXIEwProjectFileX
Expand IEwProjectFolderManagerXIEwProjectFolderManagerX
Expand IEwProjectFolderXIEwProjectFolderX
Expand IEwProjectFunctionManagerXIEwProjectFunctionManagerX
Expand IEwProjectFunctionXIEwProjectFunctionX
Expand IEwProjectGenerateTSDrawingXIEwProjectGenerateTSDrawingX
Expand IEwProjectHarnessManagerXIEwProjectHarnessManagerX
Expand IEwProjectHarnessXIEwProjectHarnessX
Expand IEwProjectInputOutputManagerXIEwProjectInputOutputManagerX
Expand IEwProjectInputOutputXIEwProjectInputOutputX
Expand IEwProjectLineManagerXIEwProjectLineManagerX
Expand IEwProjectLineXIEwProjectLineX
Expand IEwProjectLocationManagerXIEwProjectLocationManagerX
Expand IEwProjectLocationXIEwProjectLocationX
Expand IEwProjectManagerXIEwProjectManagerX
IEwProjectManufacturerPartCircuitX
Expand IEwProjectManufacturerPartManagerXIEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
Expand IEwProjectManufacturerPartXIEwProjectManufacturerPartX
Expand IEwProjectMultilingualTextFontXIEwProjectMultilingualTextFontX
Expand IEwProjectMultilingualTextManagerXIEwProjectMultilingualTextManagerX
Expand IEwProjectMultilingualTextXIEwProjectMultilingualTextX
Expand IEwProjectNumberDocumentsXIEwProjectNumberDocumentsX
Expand IEwProjectNumberMarksXIEwProjectNumberMarksX
Expand IEwProjectNumberWiresXIEwProjectNumberWiresX
Expand IEwProjectOptimizeWireOrderXIEwProjectOptimizeWireOrderX
Expand IEwProjectPrintConfigManagerXIEwProjectPrintConfigManagerX
Expand IEwProjectPrintConfigXIEwProjectPrintConfigX
Expand IEwProjectReportManagerXIEwProjectReportManagerX
Expand IEwProjectReportXIEwProjectReportX
Expand IEwProjectSnapshotManagerXIEwProjectSnapshotManagerX
Expand IEwProjectSnapshotXIEwProjectSnapshotX
Expand IEwProjectSymbolCircuitXIEwProjectSymbolCircuitX
Expand IEwProjectSymbolManagerXIEwProjectSymbolManagerX
Expand IEwProjectSymbolPointXIEwProjectSymbolPointX
Expand IEwProjectSymbolXIEwProjectSymbolX
Expand IEwProjectTagObjectXIEwProjectTagObjectX
Expand IEwProjectUpdateReplaceDataXIEwProjectUpdateReplaceDataX
Expand IEwProjectWireManagerXIEwProjectWireManagerX
Expand IEwProjectWireStyleBaseIEwProjectWireStyleBase
Expand IEwProjectWireStyleGroupXIEwProjectWireStyleGroupX
Expand IEwProjectWireStyleManagerXIEwProjectWireStyleManagerX
IEwProjectWireStyleSynopticX
Expand IEwProjectWireStyleXIEwProjectWireStyleX
Expand IEwProjectWireXIEwProjectWireX
Expand IEwProjectXIEwProjectX
Expand IEwResumeRowXIEwResumeRowX
Expand IEwRibbonComboBoxControlXIEwRibbonComboBoxControlX
Expand IEwRibbonControlXIEwRibbonControlX
Expand IEwRibbonGroupXIEwRibbonGroupX
Expand IEwRibbonQuickAccessControlXIEwRibbonQuickAccessControlX
Expand IEwRibbonTabXIEwRibbonTabX
Expand IEwRibbonXIEwRibbonX
Expand IEwRightsManagerXIEwRightsManagerX
Expand IEwSaveDWGImageXIEwSaveDWGImageX
Expand IEwSelectorDialogXIEwSelectorDialogX
Expand IEwSymbolCircuitXIEwSymbolCircuitX
Expand IEwSymbolFiltersXIEwSymbolFiltersX
Expand IEwSymbolManagerXIEwSymbolManagerX
Expand IEwSymbolPointXIEwSymbolPointX
Expand IEwSymbolXIEwSymbolX
Expand IEwTerminalTypeManagerXIEwTerminalTypeManagerX
Expand IEwTerminalTypeXIEwTerminalTypeX
Expand IEwTitleBlockManagerXIEwTitleBlockManagerX
Expand IEwTitleBlockXIEwTitleBlockX
Expand IEwWireTerminationTypeManagerXIEwWireTerminationTypeManagerX
Expand IEwWireTerminationTypeXIEwWireTerminationTypeX
Expand IEwXLSBookXIEwXLSBookX
Expand IEwXLSSheetXIEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Class Index
Expand Class HierarchyClass Hierarchy
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 SOLIDWORKS Visualize API HelpSOLIDWORKS Visualize 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 2025.0.0
Electrical API
Public Member Functions | List of all members
IEwProjectSymbolX Interface Reference

Use this interface to manage symbol inside a project. More...

Inheritance diagram for IEwProjectSymbolX:

Public Member Functions

long getFileID (EwErrorCode *errorCode)
 Return the file ID containing the symbol. More...
 
long getLocationID (EwErrorCode *errorCode)
 Return the Location ID of the symbol. More...
 
long getFunctionID (EwErrorCode *errorCode)
 Return the Function ID to the symbol. More...
 
BSTR getEwSymbolName (EwErrorCode *errorCode)
 Return the symbol name of the symbol in the library. More...
 
EwErrorCode setEwSymbolName (BSTR strSymbolName)
 Sets the symbol name of the symbol. More...
 
long getObjectID (EwErrorCode *errorCode)
 
EwErrorCode setObjectID (long lID)
 Sets the Object associated with the symbol. More...
 
EwSymbolType getEwSymbolType (EwErrorCode *errorCode)
 Return the type of the symbol. More...
 
EwMeasurementType getEwMeasurementType (EwErrorCode *errorCode)
 Return the measurement type of the symbol. More...
 
EwErrorCode setEwMeasurementType (EwMeasurementType eMeasurementType)
 Set the measurement type of the symbol. More...
 
EwSymbolCrossRefType getEwSymbolCrossRefType (EwErrorCode *errorCode)
 Return the cross reference type of the symbol. More...
 
BSTR getAssociatedMacro (EwErrorCode *errorCode)
 Return the associated macro of the symbol. More...
 
double getXPosition (EwErrorCode *errorCode)
 Return the X coordinate of the symbol. More...
 
EwErrorCode setXPosition (double dXCoordinate)
 Sets the X coordinate of the symbol. More...
 
double getYPosition (EwErrorCode *errorCode)
 Return the Y coordinate of the symbol. More...
 
EwErrorCode setYPosition (double dYCoordinate)
 Sets the Y coordinate of the symbol. More...
 
long getManufacturerPartID (EwErrorCode *errorCode)
 Return the ManufacturerPart ID associated with the symbol. More...
 
BSTR getColumnMark (EwErrorCode *errorCode)
 Return the column mark of the symbol. More...
 
BSTR getRowMark (EwErrorCode *errorCode)
 Return the row mark of the symbol. More...
 
double getRotationAngle (EwErrorCode *errorCode)
 Return the rotation angle in degrees of the symbol. More...
 
EwErrorCode setRotationAngle (double dAngle)
 Set the rotation angle in degrees of the symbol. More...
 
EwErrorCode setYScale (double dYScale)
 Sets the Y scale of the symbol. More...
 
double getYScale (EwErrorCode *errorCode)
 Return the Y scale of the symbol. More...
 
double getXScale (EwErrorCode *errorCode)
 Return the X scale of the symbol. More...
 
EwErrorCode setXScale (double dXScale)
 Sets the X scale of the symbol. More...
 
LONG getEwProjectSymbolPointCount ()
 Get the number of connection point in the symbol. More...
 
IEwProjectSymbolPointX getEwProjectSymbolPointAt (LONG lPointIndex, EwErrorCode *errorCode)
 Get the connection point at the specified index. More...
 
VARIANT getEwProjectSymbolPointArray (EwErrorCode *errorCode)
 Get the array of all the symbol's connection points. More...
 
LONG getEwProjectSymbolCircuitCount ()
 Get the number of circuits in the symbol. More...
 
IEwProjectSymbolCircuitX getEwProjectSymbolCircuitAt (LONG lCircuitIndex, EwErrorCode *errorCode)
 Get the circuit at the specified index. More...
 
VARIANT getEwProjectSymbolCircuitArray (EwErrorCode *errorCode)
 Get the array of all the symbol's circuits. More...
 
double getWidth (EwErrorCode *errorCode)
 Return the width (X size) of the symbol. More...
 
EwErrorCode setWidth (double dWidth)
 Sets the width (X size) of the symbol. More...
 
double getHeight (EwErrorCode *errorCode)
 Return the height (Y size) of the symbol. More...
 
EwErrorCode setHeight (double dHeight)
 Sets the height (Y size) of the symbol. More...
 
- Public Member Functions inherited from IEwObjectX
LONG getID ()
 
- Public Member Functions inherited from IEwObjectBaseX
EwErrorCode insert ()
 Insert the object inside the current project. More...
 
EwErrorCode remove ()
 Remove the object from the current project. More...
 
EwErrorCode update ()
 Update the object inside the current project. More...
 

Detailed Description

Use this interface to manage symbol inside a project.

Since
2019 SP1

Member Function Documentation

◆ getAssociatedMacro()

BSTR IEwProjectSymbolX::getAssociatedMacro ( EwErrorCode *  errorCode)

Return the associated macro of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
will contain the associated macro

◆ getColumnMark()

BSTR IEwProjectSymbolX::getColumnMark ( EwErrorCode *  errorCode)

Return the column mark of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the column mark of the symbol.

◆ getEwMeasurementType()

EwMeasurementType IEwProjectSymbolX::getEwMeasurementType ( EwErrorCode *  errorCode)

Return the measurement type of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the measurement type

◆ getEwProjectSymbolCircuitArray()

VARIANT IEwProjectSymbolX::getEwProjectSymbolCircuitArray ( EwErrorCode *  errorCode)

Get the array of all the symbol's circuits.

Since
2025 SP0.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
An array of IEwProjectSymbolCircuitX

◆ getEwProjectSymbolCircuitAt()

IEwProjectSymbolCircuitX IEwProjectSymbolX::getEwProjectSymbolCircuitAt ( LONG  lCircuitIndex,
EwErrorCode *  errorCode 
)

Get the circuit at the specified index.

Since
2025 SP0.
Parameters
[in]lCircuitIndexThe index of the circuit you want to get
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if lCircuitIndex is not valid or the symbol is not inserted
  • EW_NO_ERROR if no error detected
Returns
IEwProjectSymbolCircuitX object at the position specified index

◆ getEwProjectSymbolCircuitCount()

LONG IEwProjectSymbolX::getEwProjectSymbolCircuitCount ( )

Get the number of circuits in the symbol.

Since
2025 SP0.
Returns
The number of circuits, 0 if the symbol is not inserted or -1 if the object was not initialized

◆ getEwProjectSymbolPointArray()

VARIANT IEwProjectSymbolX::getEwProjectSymbolPointArray ( EwErrorCode *  errorCode)

Get the array of all the symbol's connection points.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
An array of IEwProjectSymbolPointX

◆ getEwProjectSymbolPointAt()

IEwProjectSymbolPointX IEwProjectSymbolX::getEwProjectSymbolPointAt ( LONG  lPointIndex,
EwErrorCode *  errorCode 
)

Get the connection point at the specified index.

Parameters
[in]lPointIndexThe index of connection point you want to get
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if index is not valid or the symbol is not inserted
  • EW_NO_ERROR if no error detected
Returns
The connection point

◆ getEwProjectSymbolPointCount()

LONG IEwProjectSymbolX::getEwProjectSymbolPointCount ( )

Get the number of connection point in the symbol.

Returns
The number of terminal, 0 if the symbol is not inserted or -1 if the object was not initialized

◆ getEwSymbolCrossRefType()

EwSymbolCrossRefType IEwProjectSymbolX::getEwSymbolCrossRefType ( EwErrorCode *  errorCode)

Return the cross reference type of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
will contain the cross reference type

◆ getEwSymbolName()

BSTR IEwProjectSymbolX::getEwSymbolName ( EwErrorCode *  errorCode)

Return the symbol name of the symbol in the library.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the symbol name of the symbol in the library.

◆ getEwSymbolType()

EwSymbolType IEwProjectSymbolX::getEwSymbolType ( EwErrorCode *  errorCode)

Return the type of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the type of the symbol.

◆ getFileID()

long IEwProjectSymbolX::getFileID ( EwErrorCode *  errorCode)

Return the file ID containing the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the file ID containing the symbol.

◆ getFunctionID()

long IEwProjectSymbolX::getFunctionID ( EwErrorCode *  errorCode)

Return the Function ID to the symbol.

Function of symbol can be different from the function of the component, for instance when a symbol is inside a function outline.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the Function ID of the symbol.

◆ getHeight()

double IEwProjectSymbolX::getHeight ( EwErrorCode *  errorCode)

Return the height (Y size) of the symbol.

Can only be used by symbols inserted in line diagrams.

Since
2025 SP01.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the symbol is not inserted or the given size is negative or the symbol has no editable size : only line diagrams or black box symbols have an editable size
  • EW_NO_ERROR if no error detected
Returns
Return the height of the symbol.

◆ getLocationID()

long IEwProjectSymbolX::getLocationID ( EwErrorCode *  errorCode)

Return the Location ID of the symbol.

Location of symbol can be different from the location of the component, for instance when a symbol is inside a location outline.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the Location ID of the symbol.

◆ getManufacturerPartID()

long IEwProjectSymbolX::getManufacturerPartID ( EwErrorCode *  errorCode)

Return the ManufacturerPart ID associated with the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the ManufacturerPart ID associated with the symbol.

◆ getObjectID()

long IEwProjectSymbolX::getObjectID ( EwErrorCode *  errorCode) 
  Return the Object ID associated with the symbol.
  Could be Component, Labels, Cable, Wire, Equipotential, Location... object.
  \param[out] errorCode EwErrorCode enum type, can be
  \li EW_UNDEFINED_ERROR if another error occurred
  \li EW_INVALID_OBJECT if object is not initialized

: *

  • EW_NO_ERROR if no error detected
    Returns
    the Object ID associated with the symbol.

◆ getRotationAngle()

double IEwProjectSymbolX::getRotationAngle ( EwErrorCode *  errorCode)

Return the rotation angle in degrees of the symbol.

0 by default.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
he rotation angle in degrees of the symbol.

◆ getRowMark()

BSTR IEwProjectSymbolX::getRowMark ( EwErrorCode *  errorCode)

Return the row mark of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the row mark of the symbol.

◆ getWidth()

double IEwProjectSymbolX::getWidth ( EwErrorCode *  errorCode)

Return the width (X size) of the symbol.

Can only be used by symbols inserted in line diagrams.

Since
2025 SP01.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the symbol is not inserted or the given size is negative or the symbol has no editable size : only line diagrams or black box symbols have an editable size
  • EW_NO_ERROR if no error detected
Returns
Return the width of the symbol.

◆ getXPosition()

double IEwProjectSymbolX::getXPosition ( EwErrorCode *  errorCode)

Return the X coordinate of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
Return the X coordinate of the symbol.

◆ getXScale()

double IEwProjectSymbolX::getXScale ( EwErrorCode *  errorCode)

Return the X scale of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
Return the X scale of the symbol.

◆ getYPosition()

double IEwProjectSymbolX::getYPosition ( EwErrorCode *  errorCode)

Return the Y coordinate of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
Return the Y coordinate of the symbol.

◆ getYScale()

double IEwProjectSymbolX::getYScale ( EwErrorCode *  errorCode)

Return the Y scale of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
Return the Y scale of the symbol.

◆ setEwMeasurementType()

EwErrorCode IEwProjectSymbolX::setEwMeasurementType ( EwMeasurementType  eMeasurementType)

Set the measurement type of the symbol.

Parameters
[in]eMeasurementTypeThe new measurement.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NOT_IMPLEMENTED not implemented method.

◆ setEwSymbolName()

EwErrorCode IEwProjectSymbolX::setEwSymbolName ( BSTR  strSymbolName)

Sets the symbol name of the symbol.

This property can only be set before inserting.

Parameters
[in]strSymbolNamestrBlockName symbol name of the symbol.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS Symbol name is empty.
  • EW_BAD_INPUTS The symbol type from the symbol name is not the same as the project symbol type.
Since
2025 SP1.
  • EW_NO_ERROR if no error detected

◆ setHeight()

EwErrorCode IEwProjectSymbolX::setHeight ( double  dHeight)

Sets the height (Y size) of the symbol.

This property can only be set after inserting. Can only be used by symbols inserted in line diagrams. If you want to set the size of a symbol before insertion, you have to set width and height to a valid value.

Since
2025 SP01.
Parameters
[in]dHeightthe height of the symbol.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the symbol is not inserted
  • EW_BAD_INPUTS the given height is less or equal than 0
  • EW_BAD_INPUTS the symbol has no editable size : only line diagrams or black box symbols have an editable size
  • EW_NO_ERROR if no error detected

◆ setObjectID()

EwErrorCode IEwProjectSymbolX::setObjectID ( long  lID)

Sets the Object associated with the symbol.

Could be Component, Labels, Cable, Wire, Equipotential, Location object.

Parameters
[in]lIDID of the Object
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected

◆ setRotationAngle()

EwErrorCode IEwProjectSymbolX::setRotationAngle ( double  dAngle)

Set the rotation angle in degrees of the symbol.

0 by default. This property can only be set before inserting.

Parameters
[in]dAngleThe new rotation angle.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected

◆ setWidth()

EwErrorCode IEwProjectSymbolX::setWidth ( double  dWidth)

Sets the width (X size) of the symbol.

This property can only be set after inserting. Can only be used by symbols inserted in line diagrams. If you want to set the size of a symbol before insertion, you have to set width and height to a valid value.

Since
2025 SP01.
Parameters
[in]dWidththe width of the symbol.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the symbol is not inserted
  • EW_BAD_INPUTS the given width is less or equal than 0
  • EW_BAD_INPUTS the symbol has no editable size : only line diagrams or black box symbols have an editable size
  • EW_NO_ERROR if no error detected

◆ setXPosition()

EwErrorCode IEwProjectSymbolX::setXPosition ( double  dXCoordinate)

Sets the X coordinate of the symbol.

This property can only be set before inserting.

Parameters
[in]dXCoordinatethe X coordinate.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected

◆ setXScale()

EwErrorCode IEwProjectSymbolX::setXScale ( double  dXScale)

Sets the X scale of the symbol.

This property can only be set before inserting.

Parameters
[in]dXScalethe X scale.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS X scale cannot be 0.
  • EW_NO_ERROR if no error detected

◆ setYPosition()

EwErrorCode IEwProjectSymbolX::setYPosition ( double  dYCoordinate)

Sets the Y coordinate of the symbol.

This property can only be set before inserting.

Parameters
[in]dYCoordinatethe Y coordinate.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected

◆ setYScale()

EwErrorCode IEwProjectSymbolX::setYScale ( double  dYScale)

Sets the Y scale of the symbol.

This property can only be set before inserting.

Parameters
[in]dYScalethe Y scale.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS Y scale cannot be 0.
  • EW_NO_ERROR if no error detected
Generated 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: IEwProjectSymbolX 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) 2025 SP2

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.

0.20.21