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
Expand 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
IEwProjectGenerateTSDrawingX Interface Reference

Use this interface to manage the generation of terminal strip drawing inside the project. More...

Inheritance diagram for IEwProjectGenerateTSDrawingX:
Inheritance graph

Public Member Functions

long getDestinationBookOrFolderID (long lEwProjectComponentID, EwErrorCode *errorCode)
 Indicates the destination book associated to a component ID. More...
 
EwErrorCode setDestinationBookOrFolderID (long lEwProjectComponentID, long lEwBookOrFolderID)
 Specify the destination book or folder when generating terminal strip drawings. More...
 
EwTSDrawingOption getDrawingOption (EwErrorCode *errorCode)
 Get the drawing option. More...
 
EwErrorCode setDrawingOption (EwTSDrawingOption eTSDrawingOption)
 Define the behavior when a terminal strip is already drawn and destination folder has changed. More...
 
EwErrorCode generate ()
 Go through all the terminal strips of the project and generate terminal strip drawings if terminal strip must be drawn. More...
 

Detailed Description

Use this interface to manage the generation of terminal strip drawing inside the project.

Since
2019

Member Function Documentation

◆ generate()

EwErrorCode IEwProjectGenerateTSDrawingX::generate ( )

Go through all the terminal strips of the project and generate terminal strip drawings if terminal strip must be drawn.

Remark: To draw a terminal strip call method EwProjectComponentX::setToDraw

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_DOES_NOT_EXIST_ERROR if at least one terminal strip configuration file is not found.
  • EW_UNDEFINED_ERROR if another error occurred

◆ getDestinationBookOrFolderID()

long IEwProjectGenerateTSDrawingX::getDestinationBookOrFolderID ( long  lEwProjectComponentID,
EwErrorCode *  errorCode 
)

Indicates the destination book associated to a component ID.

It must return the default book shown in terminal strip if setDestinationBookOrFolderID has not been called for this componentID, otherwise it must return the one defined when calling setDestinationBookOrFolderID

Parameters
[in]lEwProjectComponentIDthe component ID of type terminal strip.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if lEwProjectComponentID is not found for the project
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the destination book associated to a component ID.

◆ getDrawingOption()

EwTSDrawingOption IEwProjectGenerateTSDrawingX::getDrawingOption ( EwErrorCode *  errorCode)

Get the drawing option.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the option set using setDrawingOption.

◆ setDestinationBookOrFolderID()

EwErrorCode IEwProjectGenerateTSDrawingX::setDestinationBookOrFolderID ( long  lEwProjectComponentID,
long  lEwBookOrFolderID 
)

Specify the destination book or folder when generating terminal strip drawings.

lEwProjectComponentID must be a valid component ID of type terminal strip and lEwBookOrFolderID must be a valid book or folder ID of the project. When calling this method it will store in a temporary array the mapping between ID of component and ID of folder / book.

Parameters
[in]lEwProjectComponentIDThe component ID of type terminal strip.
[in]lEwBookOrFolderIDThe ID of the destination book or folder where terminal strip drawings will be generated.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if lEwProjectComponentID is not found or lEwProjectComponentID is not a terminal strip for the project
  • EW_BAD_INPUTS if lEwBookOrFolderID is not found in the project
  • EW_UNDEFINED_ERROR if another error occurred

◆ setDrawingOption()

EwErrorCode IEwProjectGenerateTSDrawingX::setDrawingOption ( EwTSDrawingOption  eTSDrawingOption)

Define the behavior when a terminal strip is already drawn and destination folder has changed.

Default value is DeleteExistingDrawing.

Parameters
[in]eTSDrawingOptionThe new drawing option to apply.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
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: IEwProjectGenerateTSDrawingX 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.56