MnuRemove
Enables the programmer to dynamically remove a menu structure from the current runtime pulldown menu structure.
|
Syntax:
|
MnuRemove (Menu Entry, Menu Path)
|
Parameters:
|
Menu Entry – A numeric value for the number of the menu in the Menu repository. You can use the MENU literal, this will ensure that the code stays correct even if the menu item changes position in the repository.
Menu Path – A string defining the path where this menu structure will be removed from. This is optional.
The menu path is made up of menu Entry Names. A backslash (\) defines a submenu. The format of the path is: Entry name[\entry name][\]
The backslash defines whether the menu structure will be removed from the submenu defined in the last <entry name>. For example: “Options\Project\” will remove the menu from the Project submenu of the Options menu entry. For more information, see: Setting Up a Menu Path.
|
Returns:
|
Logical – True if successful
|
Example:
|
MnuRemove ('2'Menu)
This will remove the second menu from the runtime menu structure.
|
Note:
|
-
Magic xpa will scan the runtime pulldown menus to find where the menu entry was added and remove it from the menus.
-
The menu structure will be removed from the first place in which it is found.
-
If the same menu was added twice, then it removes them one at a time.
-
If the menu does not exist in the current runtime pulldown menu, the function will return false.
-
The entry will only be removed in the runtime context where the function was executed.
-
If the number of the menu being removed is the top level, then the entire menu disappears.
-
In Android and iOS, the MnuRemove function is supported only for context menu.
|
Exceptions:
|
This function is not supported in Web Client tasks.
|
Platform specific:
|
This function is supported on Android and iOS devices. Since version: 3.3c
|
See also:
|
How Do I Change the Menu of a Running Program?
The Online and Rich Client Samples projects (program MN02 and RMN02)
|
Since version: Rich Client support: 2.2