Hide Table of Contents
AddCommandItem2 Method (ICommandGroup)

Adds a combination menu item and toolbar item to a CommandGroup.

.NET Syntax

Visual Basic (Declaration) 
Function AddCommandItem2( _
   ByVal Name As System.String, _
   ByVal Position As System.Integer, _
   ByVal HintString As System.String, _
   ByVal ToolTip As System.String, _
   ByVal ImageListIndex As System.Integer, _
   ByVal CallbackFunction As System.String, _
   ByVal EnableMethod As System.String, _
   ByVal UserID As System.Integer, _
   ByVal MenuTBOption As System.Integer _
) As System.Integer
Visual Basic (Usage) 
Dim instance As ICommandGroup
Dim Name As System.String
Dim Position As System.Integer
Dim HintString As System.String
Dim ToolTip As System.String
Dim ImageListIndex As System.Integer
Dim CallbackFunction As System.String
Dim EnableMethod As System.String
Dim UserID As System.Integer
Dim MenuTBOption As System.Integer
Dim value As System.Integer
 
value = instance.AddCommandItem2(Name, Position, HintString, ToolTip, ImageListIndex, CallbackFunction, EnableMethod, UserID, MenuTBOption)
C# 
System.int AddCommandItem2( 
   System.string Name,
   System.int Position,
   System.string HintString,
   System.string ToolTip,
   System.int ImageListIndex,
   System.string CallbackFunction,
   System.string EnableMethod,
   System.int UserID,
   System.int MenuTBOption
)
C++/CLI 
System.int AddCommandItem2( 
&   System.String^ Name,
&   System.int Position,
&   System.String^ HintString,
&   System.String^ ToolTip,
&   System.int ImageListIndex,
&   System.String^ CallbackFunction,
&   System.String^ EnableMethod,
&   System.int UserID,
&   System.int MenuTBOption
) 

Parameters

Name
Name of the item to add to the CommandGroup
Position

Position of the item within the CommandGroup

NOTE: Specify 0 to add this item to the beginning of the CommandGroup, or specify -1 to add it to the end of the CommandGroup. This argument specifies the position of the item in relation to its immediate parent item.

HintString
Text displayed in the SOLIDWORKS status bar when the pointer is on the item
ToolTip
ToolTip displayed when the pointer is on the item
ImageListIndex
Index number of the image for the item in the parent CommandGroup (see Remarks)
CallbackFunction

Function to call when this item is selected (see Remarks)

EnableMethod
Optional function that controls the state of the item; if specified, then SOLIDWORKS calls this function before displaying the item
If your method
returns...
Then SOLIDWORKS...

0

Deselects and disables the item

1

Deselects and enables the item; this is the default state if no update function is specified

2

Selects and disables the item

3

Selects and enables the item

4

Not supported
(see Remarks)
UserID

User-defined command ID or 0 if not used

MenuTBOption

Command item type as defined in swCommandItemType_e

Return Value

Index of the item within the CommandGroup as assigned by SOLIDWORKS

Example

Remarks

See Add-in Callback and Enable Methods to learn how to specify CallbackFunction and EnableMethod.

ImageListIndex is 0-based. The size of the index is equal to number of the images in the image files for that CommandGroup. See ICommandGroup::IconList for details. You can use -1 for ImageListIndex to specify that no icon is needed for a command item of type swCommandItemType_e.swMenuItem; however, command items of type swCommandItemType_e.swToolbarItem always need an icon.

 

See Also

Availability

SOLIDWORKS 2007 FCS, Revision Number 15


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:   AddCommandItem2 Method (ICommandGroup)
*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) 2017 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.