Adds a menu item and image to the SOLIDWORKS user interface.
.NET Syntax
Visual Basic (Declaration) | |
---|
Function AddMenuItem5( _
ByVal DocumentType As System.Integer, _
ByVal Cookie As System.Integer, _
ByVal As System.String, _
ByVal Position As System.Integer, _
ByVal As System.String, _
ByVal As System.String, _
ByVal HintString As System.String, _
ByVal ImageList As System.Object _
) As System.Integer |
Visual Basic (Usage) | |
---|
Dim instance As ISldWorks
Dim DocumentType As System.Integer
Dim Cookie As System.Integer
Dim MenuItem As System.String
Dim Position As System.Integer
Dim MenuCallback As System.String
Dim MenuEnableMethod As System.String
Dim HintString As System.String
Dim ImageList As System.Object
Dim value As System.Integer
value = instance.AddMenuItem5(DocumentType, Cookie, MenuItem, Position, MenuCallback, MenuEnableMethod, HintString, ImageList) |
Parameters
- DocumentType
Document type to which to add the menu item as defined by swDocumentTypes_e
- Cookie
- Cookie as defined in ISwAddin::ConnectToSW
- MenuItem
Menu item string ( e.g., "menuItem@menuString"); SOLIDWORKS creates menu items only if they do not already exist
NOTES:
- Specify the name of the menu for menuString (e.g., File, View, etc.) where you want your menu item to appear. If you do not specify menu string, then the menu item appears on the Tools menu below the Xpress Products menu item.
- To add your own menu to which to add this menu item, call ISldWorks::AddMenu and substitute the name of your menu for menuString.
- Use the & symbol to include an accelerator key, e.g., MyItem@, adds MyItem to the File menu with an accelerator key. To display the accelerator key, press the Alt key. The accelerator key is underlined.
- Position
Position where to add the new menu item; the first item is position 0; if -1 is specified for Position, then the new menu item is added to the bottom of the list; this argument specifies the position of the menu item in relation to its immediate parent menu
- MenuCallback
- Function to call when this menu item is selected (see Remarks)
- MenuEnableMethod
Optional function that controls the state of the menu item (See Remarks)
If specified:
If MenuEnableMethod returns... |
Then SOLIDWORKS... |
0 |
Deselects and disables the menu item |
1 |
Deselects and enables the menu item; this is the default menu state if no update function is specified |
2 |
Selects and disables the menu item |
3 |
Selects and enables the menu item |
- HintString
Text to show in the SOLIDWORKS status bar when the user moves the pointer over this menu item; if you specify HintString, then it must be preceded by a comma
- ImageList
- Array of strings for the paths for the image files for the menu item (see Remarks)
Return Value
SOLIDWORKS runtime command ID if successful or -1 if unsuccessful
Example
Remarks
See Also
Availability
SOLIDWORKS 2016 FCS, Revision Number 24.0