TOOLBAR section

The TOOLBAR section defines a toolbar with buttons that are bound to actions.

Syntax

TOOLBAR [toolbar-identifier] [ ( toolbar-attribute [,...] ) ]
  { item
  | placeholder
  | separator
  } [...]
END
  1. toolbar-identifier defines the name of the toolbar (optional).
  2. toolbar-attribute is one of: STYLE, TAG, BUTTONTEXTHIDDEN.
where item is:
ITEM item-identifier [ ( item-attribute [,...] ) ]
  1. item-identifier defines the name of the action to bind to, it is mandatory.
  2. item-attribute is one of: STYLE, TAG, TEXT, IMAGE, COMMENT, HIDDEN, AUTOHIDE.
and placeholder is:
AUTOITEMS ( CONTENT = { ACTIONS | PROGRAMS | WINDOWS } )
  1. ACTIONS stands for action views to be rendered for all default action views shown in the action panel.
  2. PROGRAMS stands for the list of current programs displayed by the front-end.
  3. WINDOWS stands for the list of windows created by the current program.
and separator is:
SEPARATOR [separator-identifier] [ (separator-attribute [,...] )
  1. separator-identifier defines the name of the separator (optional).
  2. separator-attribute is one of: STYLE, TAG, HIDDEN.

Form attributes

AUTOHIDE, BUTTONTEXTHIDDEN, COMMENT, HIDDEN, IMAGE, STYLE, TEXT, TAG.

Style attributes

Common: backgroundColor, border, fontFamily, fontSize, fontStyle, fontWeight, textColor, textDecoration.

Class-specific: scaleIcon, aspect, size.

Usage

The TOOLBAR section defines a toolbar in a form.

The TOOLBAR section must appear in the sequence described in form file structure.

The TOOLBAR section is optional.

A TOOLBAR section defines a set of ITEM elements that can be grouped by using a SEPARATOR element. Each ITEM defines a toolbar button associated with an action by name. The SEPARATOR keyword specifies a vertical line.

The toolbar buttons are enabled depending on the actions defined by the current interactive instruction. For example, you can define a toolbar button with the action name "cancel" to bind the toolbar item to this predefined dialog action. Toolbar items can be automatically hidden when the corresponding action is disabled, by using the AUTOHIDE attribute for the item.

Toolbar button labels are visible by default. The TOOLBAR supports the BUTTONTEXTHIDDEN attribute to hide the labels of buttons.

TOOLBAR elements can include AUTOITEMS place holders, with a mandatory CONTENT attribute, to define if the auto-commands must show action views for the current actions not bound to an explicit action view (CONTENT=ACTIONS), to show the list of current running programs (CONTENT=PROGRAMS), or to show the list of opened windows of the current program (CONTENT=WINDOWS).
Note:

When the toolbar is displayed in the chromebar (with toolBarPosition="chrome" style attribute), AUTOITEMS are not rendered.

TOOLBAR elements can get a STYLE attribute in order to use a specific rendering and decoration, based on presentation style definitions.

Example

TOOLBAR tb ( STYLE="mystyle" )
  ITEM accept ( TEXT="Ok", IMAGE="ok" )
  ITEM cancel ( TEXT="Cancel", IMAGE="cancel" )
  SEPARATOR ( TAG="lastSeparator")
  ITEM append ( TEXT="Append", IMAGE="add" )
  ITEM update ( TEXT="Update", IMAGE="modify" )
  ITEM delete ( TEXT="Delete", IMAGE="del" )
  ITEM search ( TEXT="Search", IMAGE="find" )
  SEPARATOR
  AUTOITEMS ( CONTENT=ACTIONS )
END