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

Use this interface to manage the Origin Destination automatic insertion. More...

Inheritance diagram for IEwProjectAutomaticArrowsX:
Inheritance graph

Public Member Functions

VARIANT_BOOL getActionOnManual (EwErrorCode *errorCode)
 Return true if the action should be done on the Manual arrows. More...
 
EwErrorCode setActionOnManual (VARIANT_BOOL bActionOnManual)
 Set this value to true if the action should be done on the Manual arrows. More...
 
EwSelectionType getSelectionType (EwErrorCode *errorCode)
 Return the EwSelectionType enum to specify the type of selection to use. More...
 
EwErrorCode setSelectionType (EwSelectionType eSelectionType)
 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 Origin Destination automatic insertion. More...
 
EwErrorCode setSelection (VARIANT vIDArray)
 Set the array of ID according to selection type. More...
 
BSTR getOriginSymbol (EwErrorCode *errorCode)
 Get the block name of symbol used for origin symbol. More...
 
EwErrorCode setOriginSymbol (BSTR strBlockName)
 Set the block name of symbol used for origin symbol. More...
 
BSTR getDestinationSymbol (EwErrorCode *errorCode)
 Get the block name of symbol used for destination symbol. More...
 
EwErrorCode setDestinationSymbol (BSTR strBlockName)
 Set the block name of symbol used for destination symbol. More...
 
EwAutoArrowLocConnectType getLocationConnectionType (EwErrorCode *errorCode)
 Return the EwAutoArrowLocConnectType enum to specify the connection type relate with the file location of the Origin Destination automatic insertion. More...
 
EwErrorCode setLocationConnectionType (EwAutoArrowLocConnectType eAutomaticArrowLocConnectionType)
 Set the EwAutoArrowLocConnectType enum to specify the connection type relate with the file location for the Origin Destination automatic insertion. More...
 
EwAutoArrowMarkType getEquipotentialConnectionType (EwErrorCode *errorCode)
 Return the EwAutoArrowMarkType enum to specify the equipotential connection with mark. More...
 
EwErrorCode setEquipotentialConnectionType (EwAutoArrowMarkType eAutomaticArrowMarkType)
 Set the the EwAutoArrowMarkType enum to specify the equipotential connection with mark. More...
 
EwErrorCode process (EwAutoArrowActionType eAutomaticArrowActionType)
 Process function to insert Origin Destination automatic arrows in the current project. More...
 

Detailed Description

Use this interface to manage the Origin Destination automatic insertion.

Since
2019 SP0

Member Function Documentation

◆ getActionOnManual()

VARIANT_BOOL IEwProjectAutomaticArrowsX::getActionOnManual ( EwErrorCode *  errorCode)

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

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 arrows.

◆ getDestinationSymbol()

BSTR IEwProjectAutomaticArrowsX::getDestinationSymbol ( EwErrorCode *  errorCode)

Get the block name of symbol used for destination symbol.

Default value is specified in the EwProjectConfigValue::kAutoConnectILinkBlockName of EwProjectConfigurationX.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the block name of symbol used for destination symbol.

◆ getEquipotentialConnectionType()

EwAutoArrowMarkType IEwProjectAutomaticArrowsX::getEquipotentialConnectionType ( EwErrorCode *  errorCode)

Return the EwAutoArrowMarkType enum to specify the equipotential connection with mark.

kManual in 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 EwAutoArrowMarkType enum to specify the equipotential connection with mark.

◆ getLocationConnectionType()

EwAutoArrowLocConnectType IEwProjectAutomaticArrowsX::getLocationConnectionType ( EwErrorCode *  errorCode)

Return the EwAutoArrowLocConnectType enum to specify the connection type relate with the file location of the Origin Destination automatic insertion.

kSameLocation 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 EwAutoArrowLocConnectType enum to specify the connection type relate with the file location of the Origin Destination automatic insertion.

◆ getOriginSymbol()

BSTR IEwProjectAutomaticArrowsX::getOriginSymbol ( EwErrorCode *  errorCode)

Get the block name of symbol used for origin symbol.

Default value is specified in the EwProjectConfigValue::kAutoConnectOLinkBlockName of EwProjectConfigurationX.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the block name of symbol used to origin symbol.

◆ getSelection()

VARIANT IEwProjectAutomaticArrowsX::getSelection ( EwErrorCode *  errorCode)

Return the array of ID used to specify the selection of objects to include in Origin Destination automatic insertion.

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

◆ getSelectionType()

EwSelectionType IEwProjectAutomaticArrowsX::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 IEwProjectAutomaticArrowsX::process ( EwAutoArrowActionType  eAutomaticArrowActionType)

Process function to insert Origin Destination automatic arrows in the current project.

Parameters
[in]eAutomaticArrowActionTypeaction for the origin destination automatic insertion.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if eAutomaticArrowActionType enumeration are not good value.
  • EW_BAD_INPUTS if the block name (for origin or destination) is not found in symbol library or is not in the good direction.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setActionOnManual()

EwErrorCode IEwProjectAutomaticArrowsX::setActionOnManual ( VARIANT_BOOL  bActionOnManual)

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

Only for the remove action. False is the Default value.

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

◆ setDestinationSymbol()

EwErrorCode IEwProjectAutomaticArrowsX::setDestinationSymbol ( BSTR  strBlockName)

Set the block name of symbol used for destination symbol.

Default value is specified in the EwProjectConfigValue::kAutoConnectILinkBlockName of EwProjectConfigurationX.

Parameters
[in]strBlockNamethe block name of symbol used for destination symbol.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the block name is not found in symbol library or is not in the good direction.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setEquipotentialConnectionType()

EwErrorCode IEwProjectAutomaticArrowsX::setEquipotentialConnectionType ( EwAutoArrowMarkType  eAutomaticArrowMarkType)

Set the the EwAutoArrowMarkType enum to specify the equipotential connection with mark.

kManual in the default value.

Parameters
[in]eAutomaticArrowMarkTypeSet 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_UNDEFINED_ERROR if another error occurred

◆ setLocationConnectionType()

EwErrorCode IEwProjectAutomaticArrowsX::setLocationConnectionType ( EwAutoArrowLocConnectType  eAutomaticArrowLocConnectionType)

Set the EwAutoArrowLocConnectType enum to specify the connection type relate with the file location for the Origin Destination automatic insertion.

kSameLocation is the default value.

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

◆ setOriginSymbol()

EwErrorCode IEwProjectAutomaticArrowsX::setOriginSymbol ( BSTR  strBlockName)

Set the block name of symbol used for origin symbol.

Default value is specified in the EwProjectConfigValue::kAutoConnectOLinkBlockName of EwProjectConfigurationX.

Parameters
[in]strBlockNamethe block name of symbol used to origin symbol.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the block name is not found in symbol library or is not in the good direction.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setSelection()

EwErrorCode IEwProjectAutomaticArrowsX::setSelection ( VARIANT  vIDArray)

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]vIDArrayan 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 IEwProjectAutomaticArrowsX::setSelectionType ( EwSelectionType  eSelectionType)

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

kSelectionAll is the default value.

Parameters
[in]eSelectionTypeSet 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 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: IEwProjectAutomaticArrowsX 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.

10.20.4