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
Collapse 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
IEwProjectSymbolX Interface Reference

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

Inheritance diagram for IEwProjectSymbolX:
Inheritance graph

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 getEwProjectLocationID (EwErrorCode *errorCode)
 Get the ID of EwProjectLocationX associated at symbol. More...
 
EwErrorCode setEwProjectLocationID (long lID)
 Set the EwProjectLocationX by ID associated at symbol. More...
 
long getEwProjectFunctionID (EwErrorCode *errorCode)
 Get the ID of EwProjectFunctionX associated at the symbol. More...
 
EwErrorCode setEwProjectFunctionID (long lID)
 Set the EwProjectFunctionX ID associated at 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

◆ getEwProjectFunctionID()

long IEwProjectSymbolX::getEwProjectFunctionID ( EwErrorCode *  errorCode)

Get the ID of EwProjectFunctionX associated at the symbol.

Since
2024 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base not initialized.
  • EW_PROJECT_NOTOPENED if project not opened.
Returns
ID of the associated function. -1 if no function associated

◆ getEwProjectLocationID()

long IEwProjectSymbolX::getEwProjectLocationID ( EwErrorCode *  errorCode)

Get the ID of EwProjectLocationX associated at symbol.

Since
2024 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base not initialized.
  • EW_PROJECT_NOTOPENED if project not opened.
  • EW_NO_ERROR if no error detected.
Returns
ID of the associated function. -1 if no location associated.

◆ 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.

◆ 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
Returns
the ManufacturerPart ID associated with the symbol.
  • EW_NO_ERROR if no error detected

◆ 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.

◆ 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_NO_ERROR if no error detected

◆ setEwProjectFunctionID()

EwErrorCode IEwProjectSymbolX::setEwProjectFunctionID ( long  lID)

Set the EwProjectFunctionX ID associated at symbol.

This property can only be set before inserting.

Since
2024 SP0
Parameters
[in]lIDid of new function to set.
Returns
errorCode EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base not initialized.
  • EW_PROJECT_NOTOPENED if project not opened.
  • EW_OBJECT_NOT_FOUND if EwProjectFunctionX not found.
  • EW_INVALID_CALL impossible to call this method, if symbol is inserted
  • EW_NO_ERROR if no error detected.

◆ setEwProjectLocationID()

EwErrorCode IEwProjectSymbolX::setEwProjectLocationID ( long  lID)

Set the EwProjectLocationX by ID associated at symbol.

This property can only be set before inserting.

Since
2024 SP0
Parameters
[in]lIDid of new location to set.
Returns
errorCode EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base not initialized.
  • EW_BAD_INPUTS if EwLocationX not exist.
  • EW_PROJECT_NOTOPENED if project not opened.
  • EW_INVALID_CALL impossible to call this method, if symbol is inserted
  • EW_NO_ERROR if no error detected.

◆ 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_INVALID_CALL impossible to call this method, if symbol is inserted
  • 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_INVALID_CALL impossible to call this method, if symbol is inserted
  • 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_INVALID_CALL impossible to call this method, if symbol is inserted
  • 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_INVALID_CALL impossible to call this method, if symbol is inserted
  • 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_INVALID_CALL impossible to call this method, if symbol is inserted
  • 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_INVALID_CALL impossible to call this method, if symbol is inserted
  • EW_NO_ERROR if no error detected
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: 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) 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.

0.20.46