Gets or changes the label of a menu option (context or drop-down menu).
// Get the label of "OPT_IconBar"
ResLabel = MenuLabel(OPT_IconBar)
Syntax
Getting the label of a menu option Hide the details
<Result> = MenuLabel([<Window>, ] <Menu option>)
<Result>: Character string
Current menu option label.
<Window>: Window name
Name of the window containing the menu option.
If this parameter is not specified, MenuLabel will handle the current window.
<Menu option>: Option name
Name of the menu option to use. This name is defined in the description window of the menu option.
This name must be specified without quotes.
Changing the label of a menu option Hide the details
<Result> = MenuLabel([<Window>, ] <Menu option> , <New caption>)
<Result>: Character string
Former menu option label.
<Window>: Optional character string
Name of the window containing the menu option.
If this parameter is not specified, MenuLabel will handle the current window.
<Menu option>: Menu option
Name of the menu option to use. This name is defined in the description window of the menu option.
This name must be specified without quotes.
<New caption>: Character string
New menu option label. You can add a help message to the menu option. This parameter has the following format: "<New label>:<Help message>.
Remarks
Special characters
- In order for the ":" character not to be considered as a help separator, this ":" character must be preceded by a "backslash" ("\").
- The "TAB" character enables you to align the following characters to the left ("\t" in the menu editor).
- The "Char(8)" character enables you to align the following characters to the right ("\a" in the menu editor).
- The "&" character placed in front of a letter is used to described this letter as shortcut for the menu option.
Equivalence
The
MenuLabel function is equivalent to the
Caption property.