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 C# SamplesC# Samples
Expand List of SWE commandsList of SWE commands
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
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
IEwProjectBookX
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 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 IEwProjectSymbolManagerXIEwProjectSymbolManagerX
Expand IEwProjectSymbolXIEwProjectSymbolX
Expand IEwProjectTagObjectXIEwProjectTagObjectX
Expand IEwProjectUpdateReplaceDataXIEwProjectUpdateReplaceDataX
Expand IEwProjectWireManagerXIEwProjectWireManagerX
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 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 2023.0.0
Electrical API
Public Member Functions | List of all members
IEwProjectNumberMarksX Interface Reference

Use this interface to manage the renumber marks. More...

Inheritance diagram for IEwProjectNumberMarksX:
Inheritance graph
[legend]

Public Member Functions

VARIANT_BOOL getActionOnManualNumber (EwErrorCode *errorCode)
 Return true if the action should be done on the Manual marks. More...
 
EwErrorCode setActionOnManualNumber (VARIANT_BOOL bActionOnManualNumber)
 Set this value to true if the action should be done on the Manual marks. More...
 
long getNumberObjectType (EwErrorCode *errorCode)
 Return the combination of EwObjectType enum to specify the type of objects to apply. More...
 
EwErrorCode addNumberObjectType (EwObjectType eNumberObjectType)
 Add the EwObjectType enum to specify the type of object to apply. More...
 
EwErrorCode setNumberObjectType (long lNumberObjectType)
 Set the EwObjectType enum to specify the type of object to apply. More...
 
VARIANT getSelection (EwErrorCode *errorCode)
 Return the array of identifiers used to specify the selection of objects to include in renumbering process. More...
 
EwErrorCode setSelection (VARIANT vIDArray)
 Set the array of identifiers of selected objects. More...
 
int getStartNumber (EwObjectType eObjectType, EwErrorCode *errorCode)
 Get the start number for one object type. More...
 
EwErrorCode setStartNumber (EwObjectType eObjectType, int iStartNumber)
 Set the start number for one selection enum. More...
 
int getStepIncrement (EwObjectType eObjectType, EwErrorCode *errorCode)
 Get the step increment for one object type. More...
 
EwErrorCode setStepIncrement (EwObjectType eObjectType, int iIncrement)
 Set the step increment for one object type. More...
 
EwErrorCode process (EwNumberMarkAction eNumberAction)
 Process function to renumber marks in the current project. More...
 

Detailed Description

Use this interface to manage the renumber marks.

Since
2019 SP0

Member Function Documentation

◆ addNumberObjectType()

EwErrorCode IEwProjectNumberMarksX::addNumberObjectType ( EwObjectType  eNumberObjectType)

Add the EwObjectType enum to specify the type of object to apply.

Parameters
[in]eNumberObjectTypeSet this value to select the type of object that you want.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ getActionOnManualNumber()

VARIANT_BOOL IEwProjectNumberMarksX::getActionOnManualNumber ( EwErrorCode *  errorCode)

Return true if the action should be done on the Manual marks.

False is the Default value.

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 action should be done on the Manual marks.

◆ getNumberObjectType()

long IEwProjectNumberMarksX::getNumberObjectType ( EwErrorCode *  errorCode)

Return the combination of EwObjectType enum to specify the type of objects to apply.

All objectType is the default value.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the EwObjectType enum to specify the type of object to apply.

◆ getSelection()

VARIANT IEwProjectNumberMarksX::getSelection ( EwErrorCode *  errorCode)

Return the array of identifiers used to specify the selection of objects to include in renumbering process.

Since
2023 SP1
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Array of identifiers used to specify the selection of objects to include in renumbering process.

◆ getStartNumber()

int IEwProjectNumberMarksX::getStartNumber ( EwObjectType  eObjectType,
EwErrorCode *  errorCode 
)

Get the start number for one object type.

Since
2023 SP1 Use only for the kReNumberMarksAction option. must be consistent with ObjectType:
  • kSelectionFolder, modify the start number for folder. Default is 1.
  • kSelectionBook, modify the start number for book. Default is 1.
  • kSelectionScheme, modify the start number for file. Default is 1.
Parameters
[in]eObjectTypeSet this value to select the type of selection that you want.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if eObjectType no exist or if is kObjectAll value.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the start number for one selection enum.

◆ getStepIncrement()

int IEwProjectNumberMarksX::getStepIncrement ( EwObjectType  eObjectType,
EwErrorCode *  errorCode 
)

Get the step increment for one object type.

Since
2023 SP1 Use only for the kReNumberMarksAction option. must be consistent with EwObjectType:
  • kObjectCable, get the step increment for cable. Default is 1.
  • kObjectComponent, get the step increment for component. Default is 1.
  • kObjectFunction, get the step increment for function. Default is 1.
  • kObjectLocation, get the step increment for location. Default is 1.
  • kObjectTerminalStrip, get the step increment for terminal strip. Default is 1.
  • kObjectTerminal, get the step increment for terminal. Default is 1.
  • kObjectHarness, get the step increment for harness. Default is 1.
Parameters
[in]eObjectTypeSet this value to select the type of object that you want.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if eObjectType no exist or if is kObjectAll value.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
The step increment for one object type

◆ process()

EwErrorCode IEwProjectNumberMarksX::process ( EwNumberMarkAction  eNumberAction)

Process function to renumber marks in the current project.

Parameters
[in]eNumberActionmark number action
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if eEwNumberAction is not allow for marks
  • EW_UNDEFINED_ERROR if another error occurred

◆ setActionOnManualNumber()

EwErrorCode IEwProjectNumberMarksX::setActionOnManualNumber ( VARIANT_BOOL  bActionOnManualNumber)

Set this value to true if the action should be done on the Manual marks.

False is the Default value.

Parameters
[in]bActionOnManualNumberSet this value to true if the action should be done on the Manual marks.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setNumberObjectType()

EwErrorCode IEwProjectNumberMarksX::setNumberObjectType ( long  lNumberObjectType)

Set the EwObjectType enum to specify the type of object to apply.

Parameters
[in]lNumberObjectTypeSet this value to select the combination type of object that you want.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setSelection()

EwErrorCode IEwProjectNumberMarksX::setSelection ( VARIANT  vIDArray)

Set the array of identifiers of selected objects.

Since
2023 SP1
Parameters
[in]vIDArrayArray of identifiers.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setStartNumber()

EwErrorCode IEwProjectNumberMarksX::setStartNumber ( EwObjectType  eObjectType,
int  iStartNumber 
)

Set the start number for one selection enum.

Since
2023 SP1 Use only for the kReNumberMarksAction option. must be consistent with SelectionType:
  • kSelectionFolder, modify the start number for folder. Default is 1.
  • kSelectionBook, modify the start number for book. Default is 1.
  • kSelectionScheme, modify the start number for file. Default is 1.
  • kSelectionAll, modify the start number for 3 previous enum. Default is 1.
Parameters
[in]eObjectTypeSet this value to select the type of selection that you want.
[in]iStartNumberset the number where the renumber start.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if eObjectType no exist or if iStartNumber are zero or négative.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setStepIncrement()

EwErrorCode IEwProjectNumberMarksX::setStepIncrement ( EwObjectType  eObjectType,
int  iIncrement 
)

Set the step increment for one object type.

Since
2023 SP1 Use only for the kReNumberMarksAction option. must be consistent with EwObjectType:
  • kObjectCable, set the step increment for cable. Default is 1.
  • kObjectComponent, set the step increment for component. Default is 1.
  • kObjectFunction, set the step increment for function. Default is 1.
  • kObjectLocation, set the step increment for location. Default is 1.
  • kObjectTerminalStrip, set the step increment for terminal strip. Default is 1.
  • kObjectTerminal, set the step increment for terminal. Default is 1.
  • kObjectHarness, set the step increment for harness. Default is 1.
Parameters
[in]eObjectTypeSet this value to select the type of object that you want.
[in]iIncrementSelection step increment.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if eObjectType no exist or if iIncrement are zero or négative.
  • EW_UNDEFINED_ERROR if another error occurred
Generated on Thu Aug 25 2022 16:02:39 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: IEwProjectNumberMarksX 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) 2023 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