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
IEwProjectWireStyleGroupX Interface Reference

Use this interface to manage Wire Style Group inside a project. More...

Inheritance diagram for IEwProjectWireStyleGroupX:
Inheritance graph

Public Member Functions

LONG getNumber (EwErrorCode *errorCode)
 Get the identifier(numberID) of the current object. More...
 
EwErrorCode setNumber (LONG lNumberID)
 Set the identifier(numberid) of the current object. More...
 
EwErrorCode setEwComputeOrderNumberType (EwComputeOrderNumberType eComputeOrderNumberType)
 Set the compute order number type of the current object. More...
 
EwComputeOrderNumberType getEwComputeOrderNumberType (EwErrorCode *errorCode)
 Get the compute order number type of the current object. More...
 
EwErrorCode setEwTagUnicityType (EwTagUnicityType eTagUnicityType)
 Set the tag unicity type of the current object. More...
 
EwTagUnicityType getEwTagUnicityType (EwErrorCode *errorCode)
 Get the tag unicity type of the current object. More...
 
EwErrorCode setActive (VARIANT_BOOL bActive)
 Set the activate state of wire style group. More...
 
VARIANT_BOOL getActive (EwErrorCode *errorCode)
 Get the activate state of wire style group. More...
 
EwErrorCode setStartOrderNo (LONG lStartOrderNo)
 Set the start order no of the current object. More...
 
LONG getStartOrderNo (EwErrorCode *errorCode)
 Get the start order no of the current 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...
 
- 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 Wire Style Group inside a project.

Since
2024 SP0

Member Function Documentation

◆ getActive()

VARIANT_BOOL IEwProjectWireStyleGroupX::getActive ( EwErrorCode *  errorCode)

Get the activate state of wire style group.

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

◆ getEwComputeOrderNumberType()

EwComputeOrderNumberType IEwProjectWireStyleGroupX::getEwComputeOrderNumberType ( EwErrorCode *  errorCode)

Get the compute order number type of the current object.

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
enum of compute order number type of the current object
  • kDifferentPerGroup order number is different for the same group
  • kCommonPerGroup order number is the same for the same group
  • kDifferentNoGroup order number is different for all the equipotentials. No group done.

◆ getEwTagUnicityType()

EwTagUnicityType IEwProjectWireStyleGroupX::getEwTagUnicityType ( EwErrorCode *  errorCode)

Get the tag unicity type of the current object.

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
enum of tag unicity type of the current object
  • kUnknowTagUnicityType Default tag unicity type
  • kTagUnicityProject Tag unicity type by project
  • kTagUnicityLocation Tag unicity type by location
  • kTagUnicityFunction Tag unicity type by function
  • kTagUnicityLocationFunction Tag unicity type by location/function
  • kTagUnicityBundle Tag unicity type by bundle
  • kTagUnicityFile Tag unicity type by file

◆ getNumber()

LONG IEwProjectWireStyleGroupX::getNumber ( EwErrorCode *  errorCode)

Get the identifier(numberID) of the current object.

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
lNumberID of the current object

◆ getStartOrderNo()

LONG IEwProjectWireStyleGroupX::getStartOrderNo ( EwErrorCode *  errorCode)

Get the start order no of the current object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT current object is invalid.
  • EW_NO_ERROR if no error detected
Returns
start order no "1" is default value

◆ getTranslatedData()

BSTR IEwProjectWireStyleGroupX::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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT current object is invalid.
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_BAD_INPUTS if the language code is not supported
  • EW_NO_ERROR No error detected
Returns
Value of the text to get

◆ setActive()

EwErrorCode IEwProjectWireStyleGroupX::setActive ( VARIANT_BOOL  bActive)

Set the activate state of wire style group.

Parameters
[in]bActivenew activated value you want to set
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

◆ setEwComputeOrderNumberType()

EwErrorCode IEwProjectWireStyleGroupX::setEwComputeOrderNumberType ( EwComputeOrderNumberType  eComputeOrderNumberType)

Set the compute order number type of the current object.

Parameters
[in]eComputeOrderNumberTypenew EwComputeOrderNumberType you want to set
  • kDifferentPerGroup order number is different for the same group
  • kCommonPerGroup order number is the same for the same group
  • kDifferentNoGroup order number is different for all the equipotentials. No group done.
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

◆ setEwTagUnicityType()

EwErrorCode IEwProjectWireStyleGroupX::setEwTagUnicityType ( EwTagUnicityType  eTagUnicityType)

Set the tag unicity type of the current object.

Parameters
[in]eTagUnicityTypenew EwTagUnicityType you want to set
  • kUnknowTagUnicityType Default tag unicity type
  • kTagUnicityProject Tag unicity type by project
  • kTagUnicityLocation Tag unicity type by location
  • kTagUnicityFunction Tag unicity type by function
  • kTagUnicityLocationFunction Tag unicity type by location/function
  • kTagUnicityBundle Tag unicity type by bundle
  • kTagUnicityFile Tag unicity type by file
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

◆ setNumber()

EwErrorCode IEwProjectWireStyleGroupX::setNumber ( LONG  lNumberID)

Set the identifier(numberid) of the current object.

Parameters
[in]lNumberIDnew number you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS EwGroupx already exist or if lNumber is negative
  • EW_NO_ERROR if no error detected

◆ setStartOrderNo()

EwErrorCode IEwProjectWireStyleGroupX::setStartOrderNo ( LONG  lStartOrderNo)

Set the start order no of the current object.

Parameters
[in]lStartOrderNonew start order no value you want to set
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

◆ setTranslatedData()

EwErrorCode IEwProjectWireStyleGroupX::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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT current object is invalid.
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_BAD_INPUTS if the language code is not supported
  • EW_NO_ERROR 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: IEwProjectWireStyleGroupX 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