Sets the contents of the tool-bar menu.
| Note: | This parameter is valid only in an Editor window. |
Scope: File
Syntax
query toolbar.Name
set toolbar.Name [BITMAP resddl_id] [ HELP HelpText] [OrdinalNumber] [Command ]
Options
Name |
Name for the item to be included on the new tool-bar menu. This name is also used as the text label on the new tool-bar menu item. To include a blank in the name, use the underscore character (_). | ||||
BITMAP |
Specifies that the new tool-bar item is
a bitmap. If used, you must also specify:
|
||||
HELP |
Optional hover-help text specified by HelpText, enclosed in quotes. When you pause the mouse cursor over your tool-bar item, this text will appear in a bubble near the mouse cursor. | ||||
OrdinalNumber |
The position at which the tool-bar item is inserted, starting at zero. If the number is greater than the first available position, or if no number is specified, the first available position is used. | ||||
Command |
The action or actions to perform when the tool-bar item is selected. |
Description
The toolbar parameter sets the tool-bar menu by adding or removing user-defined items from the tool-bar. It can also remove default Editor window tool-bar items.
If only the name of an existing tool-bar item is given when setting the toolbar parameter, that item is deleted from the tool-bar menu.
When specifying the name of user-defined tool-bar items, Name is case-sensitive. You must enter the tool-bar item text name exactly as it appears. Where a space appears, substitute the underscore character ( _).
Default Editor window tool-bar items must be referred to by their reserved names, as listed below:
LP_NEWNew LP_OPENEDITOpen LP_SAVESave LP_PRINTPrint... LP_UNDOUndo LP_REDORedo LP_CLIPCUTCut LP_CLIPCOPYCopy LP_CLIPPASTEPaste LP_SELALLSelect all LP_DESELALLDeselect all LP_FINDCHANGEFind LP_COMPARECompare LP_RECSTARTStart recording LP_RECHALTStop recording LP_RECPLAYPlayback recording LP_FONTSFonts LP_TOKENSColors LP_RINGCONFIGURERing manager LP_NEXTINRINGNext in ring LP_PREVINRINGPrevious in ring LP_NEXTRINGNext ring LP_PREVRINGPrevious ring LP_HELPINDEXHelp index LP_GENERALHELPGeneral help LP_USINGHELPUsing help
Examples
set toolbar.LP_NEW
set toolbar.Open dialog open
set toolbar.Open HELP "display the open dialog" 2 dialog open
To create an iconic tool-bar item with the same function as Example 1, type:
set toolbar.Open BITMAP evfwrc21_2 dialog open
API Return Code
-1 |
The option specified for the bitmap was not valid. |
![]()
toolbarlist Parameter
toolshow Parameter
