AddMenuItem(MultiLangString,String,String,UInt32,Int32,Boolean,Boolean) Method

In This Topic

Adds a new menu item.

Syntax

C#
C++/CLI

public uint AddMenuItem( 
   MultiLangString strMLText,
   string strActionName,
   string strStatusText,
   uint nCommandId,
   int nInsertPosition,
   bool bSeparatorBefore,
   bool bSeparatorBehind
)

public:
uint AddMenuItem( 
   MultiLangString^ strMLText,
   String^ strActionName,
   String^ strStatusText,
   uint nCommandId,
   int nInsertPosition,
   bool bSeparatorBefore,
   bool bSeparatorBehind
)

Parameters

strMLText: Text of the new menu item.
strActionName: Name of the Eplan.EplApi.ApplicationFramework.Action to be performed when the menu item is selected. Also its parameters can be passed here. Must be unique within menu.
strStatusText: Text shown in the status bar when menu is selected.
nCommandId: The command id to insert the new one before.
nInsertPosition: The count of menus to step over before inserting. 0 inserts before, 1 inserts behind, MaxValue at end, MinValue at beginning
bSeparatorBefore: Add a Separator before the new insert menu
bSeparatorBehind: Add a Separator behind the new insert menu

Return Value

The identifying command ID of the added menu item. Is valid as long as the application runs. Can be used to add another menu before/behind. Please be aware that command Id is not unique per menu point, but per action command line (i.e. action including its parameters).

Reference

Menu Class
Menu Members
Overload List

Send Feedback