Hide Table of Contents
AddMenuPopupItem4 Method (ISldWorks)

Adds a menu item, or submenu and menu item, to shortcut menus of entities of the specified type in documents of the specified type.

.NET Syntax

Visual Basic (Declaration) 
Function AddMenuPopupItem4( _
   ByVal DocumentType As System.Integer, _
   ByVal Cookie As System.Integer, _
   ByVal SelectType As System.String, _
   ByVal PopupItemName As System.String, _
   ByVal MenuCallback As System.String, _
   ByVal MenuEnableMethod As System.String, _
   ByVal HintString As System.String, _
   ByVal CustomNames As System.String _
) As System.Integer
Visual Basic (Usage) 
Dim instance As ISldWorks
Dim DocumentType As System.Integer
Dim Cookie As System.Integer
Dim SelectType As System.String
Dim PopupItemName As System.String
Dim MenuCallback As System.String
Dim MenuEnableMethod As System.String
Dim HintString As System.String
Dim CustomNames As System.String
Dim value As System.Integer
 
value = instance.AddMenuPopupItem4(DocumentType, Cookie, SelectType, PopupItemName, MenuCallback, MenuEnableMethod, HintString, CustomNames)
C# 
System.int AddMenuPopupItem4( 
   System.int DocumentType,
   System.int Cookie,
   System.string SelectType,
   System.string PopupItemName,
   System.string MenuCallback,
   System.string MenuEnableMethod,
   System.string HintString,
   System.string CustomNames
)
C++/CLI 
System.int AddMenuPopupItem4( 
&   System.int DocumentType,
&   System.int Cookie,
&   System.String^ SelectType,
&   System.String^ PopupItemName,
&   System.String^ MenuCallback,
&   System.String^ MenuEnableMethod,
&   System.String^ HintString,
&   System.String^ CustomNames
) 

Parameters

DocumentType

Document type as defined by swDocumentTypes_e

Cookie

Cookie as defined in ISwAddin::ConnectToSW

SelectType

Selection type as returned by IFeature::GetTypeName2

PopupItemName

Description displayed on the shortcut menu

MenuCallback

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

MenuEnableMethod

Optional function that controls the state of the menu item

If specified:

  • SolidWorks calls this function before displaying the menu

  • Display of the menu item is controlled by the return value of MenuEnableMethod

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

4

Hides the menu item

(see Remarks)
HintString
Text to show in the SolidWorks status bar when the user moves a mouse over this menu item
CustomNames

Semi-colon separated list of the names of the custom features; this argument is applicable only if SelectType is a custom feature type (like Attribute); in the case of Attribute, set this field to a list of attribute definitions

Return Value

SolidWorks runtime command ID or -1 if the method fails

Remarks

See Add-in Callback and Enable Methods to learn how to specify MenuCallback and MenuEnableMethod.

Call this method for every unique set of DocumentType and SelectType in whose menus you want this menu item to display.

 

Use the at-sign (@) in PopupItemName to create a submenu. To add a separator bar after a menu item, append an at-sign to PopupItemName and enclose PopupItemName in double quotes (") .

 

For example, specifying:

 

  • Edge adds Edge to the shortcut menu

  • Edge@Color adds a submenu Edge and Color to the submenu Edge

  • Edge@Appearance@Color adds the submenu Edge, the submenu Appearance to the submenu Edge, and Color to the submenu Appearance

  • "Edge@" adds the submenu Edge and a separator bar to it

  • "Edge@Appearance@" adds the submenu Edge to the shortcut menu, the submenu Appearance to the submenu Edge, and a separator bar to the submenu Appearance

 

See Also

Availability

SolidWorks 2011 FCS, Revision Number 19.0


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:   AddMenuPopupItem4 Method (ISldWorks)
*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) 2013 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.