Appxweb Meta
Home > Developer > Objects > toolbar


meta - AML object declaration extension - AML object declaration package - AML object declaration data - AML object declaration function - AML object declaration view - AML object declaration scalar - AML object declaration array - AML object declaration pointer - AML object declaration script - AML object declaration call_script - AML object declaration render - AML object declaration navigate - AML object declaration menu - AML object declaration menu - AML object declaration dialog - AML object declaration report - AML object declaration window - AML object declaration

<toolbar>

Figure: Object Chart (toolbar Object Highlighted)
Syntax <toolbar>
Syntax <control> space
Syntax <control> separator
Syntax <control> button
Syntax <control> button menu
Syntax <control> button drop
Syntax <control> button check
Syntax <control>edit box
Syntax <control>combo_box
Syntax <control>image
Example
 
Element: toolbar
Parent: view
Description: Declaration of a toolbar object. The toolbar object is comprised of space, separator, button, button menu, edit, combo and image controls..
Occurs: 0 or unbound. (i. e Within the <view> element the <toolbar> element can occur zero or many times.)
 Attribute: view_id
 Description: Unique alphanumeric indentifier of this menu view object.
Value Type: string
Value: user defined
Occurs: 1 (i.e required)
 
Element: control
Parent: toolbar
Description: Block element containing the declarations of individual controls which make up the toolbar.
Occurs: 0 or unbound (i. e Within the <toolbar> element the <control> element can occur zero or many times.)
 
Element: space
Parent: control
Description: Block element describing a spacer control used to separate other controls by a fixed amount of pixels.
Occurs: 1 (i.e required)
 
Element: separator
Parent: control
Description: Empty element describing a toolbar separator control.
Occurs: 1 (i.e required)
 
Element: button
Parent: control
Description: Block element describing a toolbar button control having caption, tooltip, and normal and hot icons. When the button is selected the function object referenced by the control's AM_function_id element is executed.
Occurs: 1 (i.e required)
 
Element: button_menu
Parent: control
Description: Block element describing a toolbar button menu control having caption, tooltip, and normal and hot icons. When the button menu is selected the menu view object referenced by the control's menu_id element is displayed.
Occurs: 1 (i.e required)
 
Element: button_drop
Parent: control
Description: Block element describing a toolbar button drop control. A button drop control combines a normal toolbar button with a toolbar button menu. When the button portion of the control is selected the function object referenced by the control's AM_function_id element is executed. When the drop arrow portion of the control is the menu view object referenced by the control's menu_id element is displayed.
Occurs: 1 (i.e required)
 
Element: button_check
Parent: control
Description: Block element describing a toolbar button check control. A button control is similar to a button control but also contains a check box which is checked and unchecked each time the button is selected.
Occurs: 1 (i.e required)
 
Element: edit_box
Parent: control
Description: Block element describing a toolbar edit box control. The edit box control supports drag drop operations and is resizable. The edit box controls text value is bound to the data object referenced by the control's AM_data_id element. Pressing the "Enter" Key whilst the control has focus causes the function object referenced by the edit box control's AM_function_id element to execute.
Occurs: 1 (i.e required)
 
Element: combo_box
Parent: control
Description: Block element describing a toolbar combo box control. The combo box control can either be static or editable, supports drag drop operations and is also resizable. The combo box text value is associated/serialized to the data object referenced by the control's AM_data_id element. The combo box list is bound to the data object referenced by the control's list_data_id element. Pressing the "Enter" Key whilst the control has focus causes 1) the controls text value to be added to be added to controls list and 2) function object referenced by the combo box control's AM_function_id element to execute.
Occurs: 1 (i.e required)
 
Element: image
Parent: control
Description: Block element describing a toolbar image control. The image control has similar to a button control but displays a graphic instead of button. The graphic image is 32 pixels high and can be in bmp, jpg or gif format. Animated gif images are supported.
Occurs: 1 (i.e required)
 
Element: caption
Parent: button, button_menu, button_drop, button_check, edit_box, combo_box, image
Description: Toolbar control caption text.
Value Type: string (parameter)
Value : user defined
Occurs: 0 or 1 (i.e optional)
 
Element: tooltip
Parent: button, button_menu, button_drop, button_check, edit_box, combo_box, image
Description: Toolbar control tooltip text.
Value Type: string (parameter)
Value : user defined
Occurs: 0 or 1 (i.e optional)
 
Element: AM_function_id
Parent: button, button_drop, button_check, edit_box, combo_box, image
Description: Identifier of the function object executed when the control is selected or the "Enter" Key is pressed.
Value Type: string (parameter)
Value : user defined
Occurs: 0 or 1 (i.e optional)
 
Element: menu_id
Parent: button_menu, button_drop
Description: Identifier of the menu object to be display when control is selected.
Value Type: string (parameter)
Value : user defined
Occurs: 1 (i.e required)
 
Element: image_file
Parent: button, button_menu, button_drop, button_check, image
Description: URL to the graphic image used by the control. In the case of button, button_menu, button_drop and button_check toolbar controls this is a 24 x 24 pixel bmp, jpg or gif image graphic. For the image toolbar control the image graphic is 24 pixels high with the width of the image specified by the width element. Additionally animated gif images are supported by the image toolbar control.
Value Type: URL
Value : user defined
Occurs: 0 or 1 (i.e optional)
 
Element: hot_image_file
Parent: button, button_menu, button_drop, button_check
Description: URL to a 24 x 24 pixel bmp, jpg or gif hot image graphic used by the control in response to a mouse over event.
Value Type: URL
Value : user defined
Occurs: 0 or 1 (i.e optional)
 
Element: AM_data_id
Parent: edit_box, combo_box
Description: Identifier of the scalar data object bound to the text value portion of an edit box control and combo box control.
Value Type: string
Value : user defined
Occurs: 0 or 1 (i.e optional)
 
Element: list_data_id
Parent:combo_box
Description: Identifier of the array data object bound to combo box control's list.
Value Type: string
Value : user defined
Occurs: 0 or 1 (i.e optional)
 
Element: min_width
Parent: edit_box, combo_box
Description: Minimum width of an edit box and combo box control during resizing of the toolbar before the control is hidden.
Value Type: unsigned integer (parameter)
Value : 0 - 1000 (default 100)
Occurs: 0 or 1 (i.e optional)
 
Element: max_width
Parent: edit_box, combo_box
Description: Maximum width of an edit box and combo box control during resizing of the toolbar.
Value Type: unsigned integer (parameter)
Value : 0 - 1000 (default 100)
Occurs: 0 or 1 (i.e optional)
 
Element: dragdrop
Parent: edit_box, combo_box
Description: Property specifying whether the toolbar control supports drag and drop operations.
Value Type: boolean
Value : "true" or "false" (default)
Occurs: 0 or 1 (i.e optional)
 
Element: combo_type
Parent:combo_box
Description: Property specifying whether the combo box control is static or editable.
Value Type: enumeration
Value :
edit - combo box values are editable
static - combo box values are static (default)
Occurs: 0 or 1 (i.e optional)
 
Element: width
Parent: image
Description:Width of the image control.
Value Type: unsigned integer (parameter)
Value :0 - 1000 (default 100)
Occurs: 0 or 1 (i.e optional)
 

top