Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
_DIEwProjectXEvents
Collapse IDispatchIDispatch
IEwAddIn
IEwAPIX
IEwApplicationReactorX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCableReferenceX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwManufacturerPartX
Expand IEwObjectBaseXIEwObjectBaseX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentCircuitX
IEwProjectComponentManagerX
IEwProjectComponentTerminalX
IEwProjectEntity3DManagerX
IEwProjectExportDWGFilesX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectManufacturerPartX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwSymbolX
IEwTitleBlockManagerX
IEwTitleBlockX
IEwXLSBookX
IEwXLSSheetX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
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 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
Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
Electrical API
Public Member Functions | List of all members
IEwProjectNumberDocumentsX Interface Reference

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

Inheritance diagram for IEwProjectNumberDocumentsX:
[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...
 
EwSelectionType getSelectionType (EwErrorCode *errorCode)
 Return the EwSelectionType enum to specify the type of selection to use. More...
 
EwErrorCode setSelectionType (EwSelectionType eSelection)
 Set the EwSelectionType enum to specify the type of selection to use. More...
 
VARIANT getSelection (EwErrorCode *errorCode)
 Return the array of ID used to specify the selection of objects to include in renumbering process. More...
 
EwErrorCode setSelection (VARIANT aIDArray)
 Set the array of ID according to selection type. More...
 
int getFirstNumber (EwSelectionType eSelection, EwErrorCode *errorCode)
 Get the first number for one selection enum. More...
 
EwErrorCode setFirstNumber (EwSelectionType eSelection, int iFirstNumber)
 Set the first number for one selection enum. More...
 
int getIncrement (EwSelectionType eSelection, EwErrorCode *errorCode)
 Get the increment for one selection enum. More...
 
EwErrorCode setIncrement (EwSelectionType eSelection, int iIncrement)
 Set the increment for one selection enum. More...
 
EwErrorCode process (EwNumberMarkAction eEwNumberAction)
 Process function to renumber marks in the current project. More...
 

Detailed Description

Use this interface to manage the renumber documents.

Since
2019 SP0

Member Function Documentation

◆ getActionOnManualNumber()

VARIANT_BOOL IEwProjectNumberDocumentsX::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.

◆ getFirstNumber()

int IEwProjectNumberDocumentsX::getFirstNumber ( EwSelectionType  eSelection,
EwErrorCode *  errorCode 
)

Get the first number for one selection enum.

Use only for the kReNumberMarksAction option. must be consistent with SelectionType:

  • kSelectionFolder, modify the first number for folder. Default is 1.
  • kSelectionBook, modify the first number for book. Default is 1.
  • kSelectionScheme, modify the first number for file. Default is 1.
    Parameters
    [in]eNumberSelectionSet 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 eSelection no exist or if is kSelectionAll value.
  • EW_UNDEFINED_ERROR if another error occurred
    Returns
    the first number for one selection enum.

◆ getIncrement()

int IEwProjectNumberDocumentsX::getIncrement ( EwSelectionType  eSelection,
EwErrorCode *  errorCode 
)

Get the increment for one selection enum.

Use only for the kReNumberMarksAction option. must be consistent with SelectionType:

  • kSelectionFolder, modify the increment for folder. Default is 1.
  • kSelectionBook, modify the increment for book. Default is 1.
  • kSelectionScheme, modify the increment for file. Default is 1.
    Parameters
    [in]eNumberSelectionSet 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 eSelection no exist or if is kSelectionAll value.
  • EW_UNDEFINED_ERROR if another error occurred

◆ getSelection()

VARIANT IEwProjectNumberDocumentsX::getSelection ( EwErrorCode *  errorCode)

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

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

◆ getSelectionType()

EwSelectionType IEwProjectNumberDocumentsX::getSelectionType ( EwErrorCode *  errorCode)

Return the EwSelectionType enum to specify the type of selection to use.

kSelectionAll 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 EwSelectionType enum to specify the type of selection to use.

◆ process()

EwErrorCode IEwProjectNumberDocumentsX::process ( EwNumberMarkAction  eEwNumberAction)

Process function to renumber marks in the current project.

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 IEwProjectNumberDocumentsX::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

◆ setFirstNumber()

EwErrorCode IEwProjectNumberDocumentsX::setFirstNumber ( EwSelectionType  eSelection,
int  iFirstNumber 
)

Set the first number for one selection enum.

Use only for the kReNumberMarksAction option. must be consistent with SelectionType:

  • kSelectionFolder, modify the first number for folder. Default is 1.
  • kSelectionBook, modify the first number for book. Default is 1.
  • kSelectionScheme, modify the first number for file. Default is 1.
  • kSelectionAll, modify the first number for 3 previous enum. Default is 1.
    Parameters
    [in]eNumberSelectionSet this value to select the type of selection that you want.
    Returns
    EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if eSelection no exist or if iFirstNumber are zero or négative.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setIncrement()

EwErrorCode IEwProjectNumberDocumentsX::setIncrement ( EwSelectionType  eSelection,
int  iIncrement 
)

Set the increment for one selection enum.

Use only for the kReNumberMarksAction option. must be consistent with SelectionType:

  • kSelectionFolder, modify the increment for folder. Default is 1.
  • kSelectionBook, modify the increment for book. Default is 1.
  • kSelectionScheme, modify the increment for file. Default is 1.
  • kSelectionAll, modify the increment for 3 previous enum. Default is 1.
    Parameters
    [in]eNumberSelectionSet this value to select the type of selection that you want.
    Returns
    EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if eSelection no exist or if iIncrement are zero or négative.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setSelection()

EwErrorCode IEwProjectNumberDocumentsX::setSelection ( VARIANT  aIDArray)

Set the array of ID according to selection type.

Array of ID must be consistent with SelectionType:

  • kSelectionFolder, the array must contains ID of EwProjectFolder
  • kSelectionBook, the array must contains ID of EwProjectBook
  • kSelectionScheme, the array must contains ID of EwProjectFile
    Parameters
    [in]aIDArrayan array of id.
    Returns
    EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setSelectionType()

EwErrorCode IEwProjectNumberDocumentsX::setSelectionType ( EwSelectionType  eSelection)

Set the EwSelectionType enum to specify the type of selection to use.

Parameters
[in]eNumberSelectionSet this value to select the type of selection that you want.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if value is kSelectionUndefined or not define in the enum.
  • EW_UNDEFINED_ERROR if another error occurred
Generated on Tue Sep 1 2020 17:01:24 for SOLIDWORKS Electrical API by   doxygen 1.8.18


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: IEwProjectNumberDocumentsX 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) 2020 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