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
Collapse IEwObjectBaseXIEwObjectBaseX
Expand IEwEnvironmentObjectXIEwEnvironmentObjectX
Collapse IEwObjectXIEwObjectX
IEwClassificationX
IEwProjectComponentCircuitX
IEwProjectConfigurationX
IEwProjectEntity3DX
IEwProjectInputOutputX
IEwProjectManufacturerPartX
IEwProjectMultilingualTextX
IEwProjectPrintConfigX
IEwProjectReportX
IEwProjectSymbolX
Expand IEwProjectTagObjectXIEwProjectTagObjectX
IEwProjectWireStyleGroupX
IEwProjectWireStyleX
IEwProjectWireX
IEwProjectComponentTerminalX
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
IEwProjectTagObjectX Interface Reference

Generic interface for an object that belongs to a project. More...

Inheritance diagram for IEwProjectTagObjectX:
Inheritance graph

Public Member Functions

EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue)
 Set user data of the object. More...
 
BSTR getUserData (LONG nUserDataNumber, EwErrorCode *errorCode)
 Get user data of the object. More...
 
EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
 Set the value of a translated text. More...
 
BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
 Get the value of a translated text. More...
 
BSTR getTag (EwErrorCode *errorCode)
 Get the mark of this object. More...
 
EwErrorCode setTag (BSTR strValue)
 Set the mark of this object. More...
 
BSTR getTagRoot (EwErrorCode *errorCode)
 Get the mark root of this object. More...
 
EwErrorCode setTagRoot (BSTR strValue)
 Set the mark root of this object. More...
 
EwTagMode getTagMode (EwErrorCode *errorCode)
 Get the mark mode of this object. More...
 
EwErrorCode setTagMode (EwTagMode eTagMode)
 Set the mark mode of this object. More...
 
long getTagNumber (EwErrorCode *errorCode)
 Get the mark number of this object. More...
 
EwErrorCode setTagNumber (long lValue)
 Set the mark number of this object. More...
 
EwErrorCode setNextTagNumber ()
 Set the next number to have a unique mark. More...
 
VARIANT_BOOL isTagUnique (EwErrorCode *errorCode)
 Returns true or false if mark is unique. More...
 
IEwObjectX duplicate (EwErrorCode *errorCode)
 Duplicate current project object. 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

Generic interface for an object that belongs to a project.

Since
2019 SP0

Member Function Documentation

◆ duplicate()

IEwObjectX IEwProjectTagObjectX::duplicate ( EwErrorCode *  errorCode)

Duplicate current project object.

Warning
The duplicate object must call insert to be save.
Since
2023 SP1
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
  • EW_OBJECT_NOT_FOUND impossible to duplicate
Returns
a copy of current project object.

◆ getTag()

BSTR IEwProjectTagObjectX::getTag ( EwErrorCode *  errorCode)

Get the mark of this object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_NO_ERROR if no error detected
Returns
a mark

◆ getTagMode()

EwTagMode IEwProjectTagObjectX::getTagMode ( EwErrorCode *  errorCode)

Get the mark mode of this object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a mark

◆ getTagNumber()

long IEwProjectTagObjectX::getTagNumber ( EwErrorCode *  errorCode)

Get the mark number of this object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a mark number

◆ getTagRoot()

BSTR IEwProjectTagObjectX::getTagRoot ( EwErrorCode *  errorCode)

Get the mark root of this object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a mark root

◆ getTranslatedData()

BSTR IEwProjectTagObjectX::getTranslatedData ( LONG  nUserDataNumber,
BSTR  strLanguage,
EwErrorCode *  errorCode 
)

Get the value of a translated text.

Parameters
[in]nUserDataNumberNumber of the text to get
[in]strLanguageLanguage code of the text to get
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_BAD_INPUTS if the language code is not supported
Returns
Value of the text to get

◆ getUserData()

BSTR IEwProjectTagObjectX::getUserData ( LONG  nUserDataNumber,
EwErrorCode *  errorCode 
)

Get user data of the object.

Parameters
[in]nUserDataNumbernumber of the user data
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
Returns
value of the user data requested

◆ isTagUnique()

VARIANT_BOOL IEwProjectTagObjectX::isTagUnique ( EwErrorCode *  errorCode)

Returns true or false if mark is unique.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true if the mark is unique.

◆ setNextTagNumber()

EwErrorCode IEwProjectTagObjectX::setNextTagNumber ( )

Set the next number to have a unique mark.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_INVALID_OBJECT if no next unique tag has been found with the specified formula
  • EW_UNDEFINED_ERROR if another error occurred

◆ setTag()

EwErrorCode IEwProjectTagObjectX::setTag ( BSTR  strValue)

Set the mark of this object.

if markmode is auto, markmode is changed to manual

Parameters
[in]strValuevalue to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_INVALID_OBJECT if object is not initialized or this object is a Terminal strip
  • EW_BAD_INPUTS if strValue is empty
  • EW_UNDEFINED_ERROR if another error occurred

◆ setTagMode()

EwErrorCode IEwProjectTagObjectX::setTagMode ( EwTagMode  eTagMode)

Set the mark mode of this object.

if we set markmode to auto, we calculate a new unique mark number and we update the mark

Parameters
[in]eTagModeenumeration value to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setTagNumber()

EwErrorCode IEwProjectTagObjectX::setTagNumber ( long  lValue)

Set the mark number of this object.

Returns error if generated mark is not unique.

Parameters
[in]lValuevalue to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_BAD_INPUTS if generated mark is not unique or negative.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setTagRoot()

EwErrorCode IEwProjectTagObjectX::setTagRoot ( BSTR  strValue)

Set the mark root of this object.

if we change root and mark mode is auto, we calculate a new unique mark number and we update the mark (mark is always unique)

Parameters
[in]strValuevalue to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setTranslatedData()

EwErrorCode IEwProjectTagObjectX::setTranslatedData ( LONG  nUserDataNumber,
BSTR  strLanguage,
BSTR  strValue 
)

Set the value of a translated text.

Parameters
[in]nUserDataNumberNumber of the text to set
[in]strLanguageLanguage of the text
[in]strValueValue of the text
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_BAD_INPUTS if the language code is not supported

◆ setUserData()

EwErrorCode IEwProjectTagObjectX::setUserData ( LONG  nUserDataNumber,
BSTR  strValue 
)

Set user data of the object.

Parameters
[in]nUserDataNumbernumber of the user data
[in]strValuevalue to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
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: IEwProjectTagObjectX 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.21