AGI Ui Plugins 11 Send comments on this topic.
AddMenuItem Method (IAgUiPluginMenuBuilder)
See Also  Example
CommandID
A named command associated with the custom context menu item.
Title
A text displayed in the context menu.
Description
A text displayed in the status bar.
PictureDisp
An icon associated with the context menu item. If null, no icon will be displayed.





Description

Adds a menu item to an existing context menu.

Syntax

[Visual Basic .NET]
Public Sub AddMenuItem( _
   ByVal CommandID As String, _
   ByVal Title As String, _
   ByVal Description As String, _
   ByVal PictureDisp As Picture _
) 

[C#]
public void AddMenuItem(
string CommandID,
string Title,
string Description,
System.Drawing.Image PictureDisp
);

[Managed C++]
public: void AddMenuItem(
String __gc ^ CommandID,
String __gc ^ Title,
String __gc ^ Description,
stdole::IPictureDisp ^ PictureDisp
);

[Java]
public  addMenuItem(
String CommandID,
String Title,
String Description,
Picture PictureDisp
);

[Unmanaged C++]
public: HRESULT AddMenuItem(
BSTR CommandID,
BSTR Title,
BSTR Description,
stdole::IPictureDisp * PictureDisp
);

Parameters

CommandID
A named command associated with the custom context menu item.
Title
A text displayed in the context menu.
Description
A text displayed in the status bar.
PictureDisp
An icon associated with the context menu item. If null, no icon will be displayed.

Remarks

AddMenuItem method is used by the User Interface plugins to configure the context menu displayed when a user right-clicks on an scenario's object.

Example

Add a menu item Copy Code
// IAgUiPluginMenuBuilder MenuBuilder; 
 
MenuBuilder.AddMenuItem("MyFirstContextMenuCommand", "A CSharp Menu Item", "Open a Custom user interface.", null); 

See Also

© 2016 Analytical Graphics, Inc. All Rights Reserved.

STK Programming Interface 11.0.1