<xml> </xml>

SOLIDWORKS PDM Professional API Help | Send Feedback
AddCmd Method (IEdmCmdMgr5)
See Also

Collapse All Expand All Language Filter: All Language Filter: Multiple Language Filter: Visual Basic Language Filter: C# Language Filter: C++/CLI

EPDM.Interop.epdm Namespace > IEdmCmdMgr5 Interface : AddCmd Method (IEdmCmdMgr5)

Visual Basic
C#
C++/CLI

lCmdID
  Command ID (see Remarks)

bsStatusBarHelp
  Optional text to show in the File Explorer status bar when the user highlights the menu entry in the right-click context menu

bsToolbarToolTip
  Optional message to display when the cursor is located over the command's toolbar button

lToolbarButtonIndex
  Optional index of a toolbar button in a resource image (see Remarks)

lToolbarImageID
  Optional ID of the image to use as a toolbar button (see Remarks)

Adds a toolbar button to the File Explorer Tools menu and a menu command to the right-click context-sensitive menu of SOLIDWORKS PDM Professional vault files and folders.

# Syntax

Visual Basic |
--- | ---

    Sub AddCmd( _
       ByVal lCmdID As System.Integer, _
       ByVal bsMenuString As System.String, _
       Optional ByVal lEdmMenuFlags As System.Integer, _
       Optional ByVal bsStatusBarHelp As System.String, _
       Optional ByVal bsToolbarToolTip As System.String, _
       Optional ByVal lToolbarButtonIndex As System.Integer, _
       Optional ByVal lToolbarImageID As System.Integer _
    )

C# |
--- | ---

    void AddCmd(
       System.int lCmdID,
       System.string bsMenuString,
       System.int lEdmMenuFlags,
       System.string bsStatusBarHelp,
       System.string bsToolbarToolTip,
       System.int lToolbarButtonIndex,
       System.int lToolbarImageID
    )

C++/CLI |
--- | ---

    void AddCmd(
    &   System.int lCmdID,
    &   System.String^ bsMenuString,
    &   System.int lEdmMenuFlags,
    &   System.String^ bsStatusBarHelp,
    &   System.String^ bsToolbarToolTip,
    &   System.int lToolbarButtonIndex,
    &   System.int lToolbarImageID
    )

#### Parameters

lCmdID
  Command ID (see Remarks)
bsMenuString
  Text to show in the menu
lEdmMenuFlags
  Optional combination of EdmMenuFlags
bsStatusBarHelp
  Optional text to show in the File Explorer status bar when the user highlights the menu entry in the right-click context menu
bsToolbarToolTip
  Optional message to display when the cursor is located over the command's toolbar button
lToolbarButtonIndex
  Optional index of a toolbar button in a resource image (see Remarks)
lToolbarImageID
  Optional ID of the image to use as a toolbar button (see Remarks)

# Remarks

Call this method in your implementation of IEdmAddIn5::GetAddInInfo to:

- Add command buttons to the File Explorer toolbar. Before calling IEdmCmdMgr5::AddCmd, call IEdmCmdMgr5::AddToolbarImage to register an image with the toolbar button you want to add.
- Add menu commands to the File Explorer Tools menu.
- Add menu commands to the right-click context menu of files or folders in the SOLIDWORKS PDM Professional vault.

lCmdID can be any value. SOLIDWORKS PDM Professional passes it to your implementation of IEdmAddIn5::OnCmd via EdmCmd::mlCmdID.

lToolbarButtonIndex is the index of the toolbar image in a resource image that contains several images.

lToolbarImageID is the same as the lImageID parameter of IEdmCmdMgr5::AddToolbarImage.

NOTE: Menu commands and toolbar buttons added using this method display only when the user browses a SOLIDWORKS PDM Professional file vault. They do not display for ordinary Windows folders.

Return codes:

- S_OK: The method successfully executed.
- S_FALSE: One of the arguments is invalid.

# See Also

####

IEdmCmdMgr5 Interface
IEdmCmdMgr5 Members
Administration Menu for Add-ins
Creating Menu Commands (VB.NET)

# Availability

SOLIDWORKS PDM Professional Version 5.2