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

Use this interface to manage an EwMenuX object. More...

Inheritance diagram for IEwMenuX:
Inheritance graph
[legend]

Public Member Functions

int getMenuItemCount (EwErrorCode *errorCode)
 Return the number of menu item(s) in the menu. More...
 
IEwMenuItemX getMenuItemAt (int iIndex, EwErrorCode *errorCode)
 Return the specified menu item of the menu. More...
 
IEwMenuItemX getMenuItemByID (int iMenuItemID, EwErrorCode *errorCode)
 Return the specified menu item of the menu by ID. More...
 
IEwMenuItemX addMenuItem (EwMenuStyle eMenuStyle, BSTR strCommand, EwErrorCode *errorCode)
 Add a new menu item at the end of the menu. More...
 
IEwMenuItemX addMenuItemAt (int iIndex, EwMenuStyle eMenuStyle, BSTR strCommand, EwErrorCode *errorCode)
 Add a new menu item at a specified position in the menu. More...
 
EwErrorCode removeMenuItemAt (int iIndex)
 Remove a menu item specified by the index in the menu. More...
 
EwErrorCode removeAll ()
 Remove all menu items. More...
 
int getXPosition (EwErrorCode *errorCode)
 Get the horizontal position in screen coordinates of the popup menu. More...
 
EwErrorCode setXPosition (int iXCoordinate)
 Set the horizontal position in screen coordinates of the popup menu. More...
 
int getYPosition (EwErrorCode *errorCode)
 Get the vertical position in screen coordinates of the top of the menu on the screen. More...
 
EwErrorCode setYPosition (int iYCoordinate)
 Set the vertical position in screen coordinates of the top of the menu on the screen. More...
 
UINT getID ()
 Get the ID of menu. More...
 
EwErrorCode showPopupMenu ()
 Display the popup menu at specified location defined by X & Y Position in screen coordinates. More...
 

Detailed Description

Use this interface to manage an EwMenuX object.

Since
2022 SP2

Member Function Documentation

◆ addMenuItem()

IEwMenuItemX IEwMenuX::addMenuItem ( EwMenuStyle  eMenuStyle,
BSTR  strCommand,
EwErrorCode *  errorCode 
)

Add a new menu item at the end of the menu.

Parameters
[in]eMenuStyleEwMenuStyle enum type
[in]strCommandthe name of a command to launch. Can be blanck.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if eMenuStyle is not a good menu style
  • EW_NO_ERROR if no error detected
Returns
an IEwMenuItemX added to the menu.

◆ addMenuItemAt()

IEwMenuItemX IEwMenuX::addMenuItemAt ( int  iIndex,
EwMenuStyle  eMenuStyle,
BSTR  strCommand,
EwErrorCode *  errorCode 
)

Add a new menu item at a specified position in the menu.

if position is negative or higher than the number of menu items in menu, then the menu item will be added at the end

Parameters
[in]iIndexposition where menu item must be inserted in menu
[in]eMenuStyleEwMenuStyle enum type
[in]strCommandthe name of a command to launch. Can be blanck.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if eMenuStyle is not a good menu style
  • EW_NO_ERROR if no error detected
Returns
an IEwMenuItemX added to the menu.

◆ getID()

UINT IEwMenuX::getID ( )

Get the ID of menu.

Returns
the ID of the menu.

◆ getMenuItemAt()

IEwMenuItemX IEwMenuX::getMenuItemAt ( int  iIndex,
EwErrorCode *  errorCode 
)

Return the specified menu item of the menu.

Parameters
[in]iIndexPosition of the menu item.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the index is negative or greater than the number of menu items
  • EW_OBJECT_NOT_FOUND if the object not found, then return null
  • EW_NO_ERROR if no error detected
Returns
an IEwMenuItemX specified.

◆ getMenuItemByID()

IEwMenuItemX IEwMenuX::getMenuItemByID ( int  iMenuItemID,
EwErrorCode *  errorCode 
)

Return the specified menu item of the menu by ID.

Parameters
[in]iMenuItemIDID of the menu item.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the iMenuItemID is negative
  • EW_OBJECT_NOT_FOUND if the object not found, then return null
  • EW_NO_ERROR if no error detected
Returns
an IEwMenuItemX specified.

◆ getMenuItemCount()

int IEwMenuX::getMenuItemCount ( EwErrorCode *  errorCode)

Return the number of menu item(s) in the menu.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the number of menu item in the menu.

◆ getXPosition()

int IEwMenuX::getXPosition ( EwErrorCode *  errorCode)

Get the horizontal position in screen coordinates of the popup menu.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_NO_ERROR if no error detected
Returns
the horizontal position in screen coordinates of the popup menu.

◆ getYPosition()

int IEwMenuX::getYPosition ( EwErrorCode *  errorCode)

Get the vertical position in screen coordinates of the top of the menu on the screen.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_NO_ERROR if no error detected
Returns
the vertical position in screen coordinates of the top of the menu on the screen.

◆ removeAll()

EwErrorCode IEwMenuX::removeAll ( )

Remove all menu items.

Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected

◆ removeMenuItemAt()

EwErrorCode IEwMenuX::removeMenuItemAt ( int  iIndex)

Remove a menu item specified by the index in the menu.

The zero-based index of the position where the menu item was inserted.

Parameters
[in]iIndexthe index of the menu item to remove.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the index is greater than the number of menu item or negative.
  • EW_NO_ERROR if no error detected

◆ setXPosition()

EwErrorCode IEwMenuX::setXPosition ( int  iXCoordinate)

Set the horizontal position in screen coordinates of the popup menu.

Parameters
[in]iXCoordinatethe X-Coordinate of the Menu
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_NO_ERROR if no error detected

◆ setYPosition()

EwErrorCode IEwMenuX::setYPosition ( int  iYCoordinate)

Set the vertical position in screen coordinates of the top of the menu on the screen.

Parameters
[in]iYCoordinatethe Y-Coordinate of the Menu
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_NO_ERROR if no error detected

◆ showPopupMenu()

EwErrorCode IEwMenuX::showPopupMenu ( )

Display the popup menu at specified location defined by X & Y Position in screen coordinates.

Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Generated on Thu Aug 25 2022 16:02:38 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: IEwMenuX 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