Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Release NotesRelease Notes
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
IEwDockingPaneManagerX
IEwDockingPaneX
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwManufacturerPartX
Expand IEwObjectBaseXIEwObjectBaseX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectComponentTerminalX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
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
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
SOLIDWORKS Electrical API  2021.0.0
Electrical API
Public Member Functions | List of all members
IEwDialogLocationSelectorX Interface Reference

Use this interface to display a location selector dialog. More...

Inheritance diagram for IEwDialogLocationSelectorX:
[legend]

Public Member Functions

void setEwProjectID (LONG lProjectID)
 Sets the project from where the dialog will take the locations. More...
 
void setEwProjectLocationID (LONG lLocationID)
 Sets the location where selected locations are inserted. More...
 
void setEwProjectBundleID (LONG lBundleID)
 Set the ID of current bundle. More...
 
void setAllowNoSelection (VARIANT_BOOL bAllowNoSelection)
 Set the possibility to return OK with no location selected. More...
 
void setFileType3d (EwFileType eFileType)
 Set file type for 3d layout insertion. More...
 
IEwProjectLocationX show (EwErrorCode *errorCode)
 Displays the dialog. More...
 

Detailed Description

Use this interface to display a location selector dialog.

Since
2018 SP0

Member Function Documentation

◆ setAllowNoSelection()

void IEwDialogLocationSelectorX::setAllowNoSelection ( VARIANT_BOOL  bAllowNoSelection)

Set the possibility to return OK with no location selected.

Parameters
[in]bAllowNoSelectionVARIANT_TRUE to allow successful return with no selection

◆ setEwProjectBundleID()

void IEwDialogLocationSelectorX::setEwProjectBundleID ( LONG  lBundleID)

Set the ID of current bundle.

Parameters
[in]lBundleIDbundle ID

◆ setEwProjectID()

void IEwDialogLocationSelectorX::setEwProjectID ( LONG  lProjectID)

Sets the project from where the dialog will take the locations.

Parameters
[in]lProjectIDID of the project

◆ setEwProjectLocationID()

void IEwDialogLocationSelectorX::setEwProjectLocationID ( LONG  lLocationID)

Sets the location where selected locations are inserted.

Parameters
[in]lLocationIDID of the location

◆ setFileType3d()

void IEwDialogLocationSelectorX::setFileType3d ( EwFileType  eFileType)

Set file type for 3d layout insertion.

Parameters
[in]eFileType3D layout file type Selection will be restricted to locations which are parents of current one, are not inserted yet, and have 3D layout created.

◆ show()

IEwProjectLocationX IEwDialogLocationSelectorX::show ( EwErrorCode *  errorCode)

Displays the dialog.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR: Dialog correctly displayed, and selection made.
  • EW_INVALID_OBJECT if object is not initialized
  • EW_OPERATION_CANCELED Selection has been cancelled; nothing selected
  • EW_OBJECT_ALREADY_INSERTED Nothing to select (layout already inserted or not exists)
  • EW_PROJECT_NOTOPENED project is not opened in user interface you must call EwApplicationX::openEwProjectID
  • EW_UNDEFINED_ERROR if another error occurred
Returns
IEwProjectLocationX pointer to the selected location
Generated on Thu Aug 20 2020 08:40:16 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: IEwDialogLocationSelectorX 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) 2021 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.48