Properties of the TOOL_BAR Object

ACTION_MOVE_BOTTOM_SIDE

Defines the adjustment of an object placed in the view of a split bar object, when the user drags the horizontal bar below the object, or when he/she resizes the window below and when the split bar expands (VERTICAL_ADJUSTMENT property equal to _SPLT_ADJUST_EXPAND_HEIGHT) and if the object belongs to one of the bottommost views.

Accessibility
Layout design mode	Read / Write,
Execution mode	Read / Write.
Associated constants
_BAR_MOVE	The control moves relative to the window.
_BAR_EXPAND	The control expands of contracts.
_BAR_ANCHOR	The control does not move relative to the window.
_BAR_DEFAULT	Corresponds to the value _BAR_ANCHOR if the control is in a pane located above the bar. Corresponds to the value _BAR_MOVE if located in a pane at the bottom.
Conditions for use	The object must be in a split bar pane.

Note: This property is not implemented in Java and Mobile generation.

ACTION_MOVE_LEFT_SIDE

Defines the adjustment of an object placed in the view of a split bar object, when the user drags the vertical bar to the left of the object, or when he/she resizes the window below and when the split bar expands (HORIZONTAL_ADJUSTMENT property equal to _SPLT_ADJUST_EXPAND_WIDTH) and if the object belongs to one of the rightmost views.

Accessibility
Layout design mode	Read / Write,
Execution mode	Read / Write.
Associated constants
_BAR_MOVE	The control moves relative to the window.
_BAR_EXPAND	The control expands of contracts.
_BAR_ANCHOR	The control does not move relative to the window.
_BAR_DEFAULT	Corresponds to the value _BAR_ANCHOR if the control is in a pane located to the left of the bar. Corresponds to the value _BAR_MOVE if located in a pane on the right.
Conditions for use	The object must be in a split bar pane.

Note: This property is not implemented in Java and Mobile generation.

ACTION_MOVE_RIGHT_SIDE

Defines the adjustment of an object placed in the view of a split bar object, when the user drags the vertical bar to the right of the object, or when he/she resizes the window below and when the split bar expands (HORIZONTAL_ADJUSTMENT property equal to _SPLT_ADJUST_EXPAND_WIDTH) and if the object belongs to one of the rightmost views.

Accessibility
Layout design mode	Read / Write,
Execution mode	Read / Write.
Associated constants
_BAR_MOVE	The control moves relative to the window.
_BAR_EXPAND	The control expands of contracts.
_BAR_ANCHOR	The control does not move relative to the window.
_BAR_DEFAULT	Corresponds to the value _BAR_ANCHOR if the control is in a pane located to the left of the bar. Corresponds to the value _BAR_MOVE if located in a pane on the right.
Conditions for use	The object must be in a split bar pane.

Note: This property is not implemented in Java and Mobile generation.

ACTION_MOVE_TOP_SIDE

Defines the adjustment of an object placed in the view of a split bar object, when the user drags the horizontal bar above the object, or when he/she resizes the window above and when the split bar expands (VERTICAL_ADJUSTMENT property equal to _SPLT_ADJUST_EXPAND_HEIGHT) and if the object belongs to one of the bottommost views.

Accessibility
Layout design mode	Read / Write,
Execution mode	Read / Write.
Associated constants
_BAR_MOVE	The control moves relative to the window.
_BAR_EXPAND	The control expands of contracts.
_BAR_ANCHOR	The control does not move relative to the window.
_BAR_DEFAULT	Corresponds to the value _BAR_ANCHOR if the control is in a pane located above the bar. Corresponds to the value _BAR_MOVE if located in a pane at the bottom.
Conditions for use	The object must be in a split bar pane.

Note: This property is not implemented in Java and Mobile generation.

ACTIVE

Determines whether or not the object reacts to events from the user interface.

Adelia type	BOOL.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	None.
Conditions for use	None.
Default value	"*TRUE".

BORDER

Determines whether there is a border around the tool bar.

Adelia type	BOOL.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	none.
Conditions for use	none.
Default value	"*TRUE".

BUTTON_HEIGHT

Height of the buttons in pixels. All the buttons are the same height.

Adelia type	NUM_BIN_2
Accessibility
Layout design mode	Read
Execution mode	Read / Write
Associated constants	None
Conditions for use	The button height must exceed the image height by at least 6 pixels.
Default value	22

Note: In layout design mode, the button size is determined automatically according to the toolbar styles and the button content (icon size, text width). In execution mode, these properties can be forced in certain conditions. However, some toolbar operations (adding a button, changing styles) can result in these properties being recalculated. This use is therefore not recommended.

BUTTON_WIDTH

Width of the buttons in pixels. Separators are 8 pixels wide.

Adelia type	NUM_BIN_2
Accessibility
Layout design mode	Read
Execution mode	Read / Write
Associated constants	None
Conditions for use	The button width must exceed the image width by at least 7 pixels.
Default value	24

Note: In layout design mode, the button size is determined automatically according to the toolbar styles and the button content (icon size, text width). In execution mode, these properties can be forced in certain conditions. However, some toolbar operations (adding a button, changing styles) can result in these properties being recalculated. This use is therefore not recommended.

HEIGHT

Object's height value.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	None.
Conditions for use	The height can only be changed if the object's automatic placement function does not impose any restrictions (cf. the PLACEMENT property).
Default value	The height depends on the objects content and styles when it is created.

HORIZONTAL_ADJUSTMENT

Defines how the graphical control is adjusted when the window is resized horizontally.

Adelia type	NUM_BIN_2.
Accessibility
Layout design mode	Read/Write.
Execution mode	Read/Write.
Associated constants
_BAR_ADJUST_EXPAND_WIDTH	The control is expanded width-wise.
_BAR_ADJUST_ALIGNED_LEFT	The control keeps its left side alignment.
_BAR_ADJUST_ALIGNED_RIGHT	The control keeps its right side alignment.
_BAR_ADJUST_ALIGNED_CENTER	The control keeps its center alignment.
_BAR_ADJUST_NONE	No horizontal adjustment is applied to the control.
Conditions for use	This property applies when the window's ADJUSTMENT property is other than _WIN_ADJUST_NONE and when the object is not part of a Split bar pane. When executed, its value is taken into account before initializing the window and when the window's ADJUSTMENT property is modified. At this point, the object's VISIBILITY property must be True. Otherwise, the control will not be adjusted. The modification is only taken into account if the window's ADJUSTMENT property is _WIN_ADJUST_NONE. Otherwise it is ignored.
Default value	_BAR_ADJUST_ALIGNED_LEFT.

Note: This property is not implemented in Java and Mobile generation.

IMAGE_HEIGHT

Height of the images in pixels. All the images are the same height.

Adelia type	NUM_BIN_2.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	None.
Conditions for use	The image height must be less than the button height by at least 6 pixels.
Default value	16.

IMAGE_WIDTH

Width of the images in pixels. All the images are the same width.

Adelia type	NUM_BIN_2.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	None.
Conditions for use	The image width must be less than the button width by at least 7 pixels.
Default value	16.

MULTILINE

Determines whether or not buttons can be arranged on more than one row.

Adelia type	BOOL.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	none.
Conditions for use	none.
Default value	"*FALSE".

NAME

Static name of the object.

Adelia type	ALPHA(128).
Accessibility
Layout design mode	Read/Write.
Execution mode	Read.
Associated constants	None.
Conditions for use	None.
Default value	Prefix of the basic object.

PLACEMENT

Type of automatic placement of the object relative to its parent window.

Adelia type	NUM_BIN_2.
Accessibility
Layout design mode	Read / Write,
Execution mode	Read / Write.
Associated constants	_BAR_AUTO_PLC_TOP: Object placed at the top of the parent's client area, with the width adjusted to fill the area and the height adjusted to that of the buttons. _BAR_AUTO_PLC_BOTTOM: Object placed at the bottom of the parent's client area, with the width adjusted to fill the area and the height adjusted to that of the buttons. _BAR_AUTO_PLC_LEFT_EDGE: Object placed at the left edge of the parent's client area, with the width adjusted to fill the area and the height adjusted to that of the buttons, and with the Y coordinate set by the user. _BAR_AUTO_PLC_USER: The user specifies the coordinates and object size as required.
Conditions for use	When the tool bar is placed in a Main window class window, the constants _BAR_AUTO_PLC_LEFT_EDGE and _BAR_AUTO_PLC_USER cannot be used. Besides the property cannot be modified anymore when executed.
Default value	_BAR_AUTO_PLC_USER.

TEXT_POSITION

Position of the buttons' text relative to the image.

Adelia type	NUM_BIN_2.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	_BAR_TXT_POS_BOTTOM: The text is located below the image. _BAR_TXT_POS_RIGHT: The text is located to the right of the image.
Conditions for use	none.
Default value	_BAR_TXT_POS_BOTTOM

TOOL_COUNT

Returns how many tools (including separators) the object has.

Adelia type	NUM_BIN_2.
Accessibility
Layout design mode	No object.
Execution mode	Read.
Associated constants	none.
Conditions for use	none.
Default value	0.

TOOLS_HOT_TRACKING

If the tools have hot tracking, the button outlines are not drawn but a border is drawn when the mouse moves over a button.

Adelia type	BOOL.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	none.
Conditions for use	none.
Default value	"*FALSE".

TRANSPARENCY

Determines whether the object background is transparent.

Adelia type	BOOL.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	none.
Conditions for use	none.
Default value	"*TRUE".

VERTICAL_ADJUSTMENT

Defines how the graphical control is adjusted when the window is resized vertically.

Adelia type	NUM_BIN_2.
Accessibility
Layout design mode	Read/Write.
Execution mode	Read/Write.
Associated constants
_BAR_ADJUST_EXPAND_HEIGHT	The control is extended height-wise.
_BAR_ADJUST_ALIGNED_TOP	The control keeps its top side alignment.
_BAR_ADJUST_ALIGNED_BOTTOM	The control keeps its bottom side alignment.
_BAR_ADJUST_ALIGNED_CENTER	The control keeps its center alignment.
_BAR_ADJUST_NONE	No vertical adjustment is applied to the control.
Conditions for use	This property applies when the window's ADJUSTMENT property is other than _WIN_ADJUST_NONE and when the object is not part of a Split bar pane. When executed, its value is taken into account before initializing the window and when the window's ADJUSTMENT property is modified. At this point, the object's VISIBILITY property must be True. Otherwise, the control will not be adjusted. The modification is only taken into account if the window's ADJUSTMENT property is _WIN_ADJUST_NONE. Otherwise it is ignored.
Default value	_BAR_ADJUST_ALIGNED_TOP.

Note: This property is not implemented in Java and Mobile generation.

VISIBILITY

Visibility of the object.

Adelia type	BOOL.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	none.
Conditions for use	none.
Default value	"*TRUE".

WIDTH

Object's width value.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	none.
Conditions for use	The width can only be changed if the object's automatic placement function does not impose any restrictions (cf. the PLACEMENT property).
Default value	The width of the parent window's client area.

X_AXIS

X coordinate value of the object's position relative to the area covered by the window, page or pane.

The reference point (origin) is the top left-hand corner of the object.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	none.
Conditions for use	The X coordinate can only be changed if the object's automatic placement function does not impose any restrictions (cf. the PLACEMENT property).
Default value	0.

Y_AXIS

Y coordinate value of the object's position relative to the area covered by the window, page or pane. The reference point (origin) is the top left-hand corner of the object.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	none.
Conditions for use	The Y coordinate can only be changed if the object's automatic placement function does not impose any restrictions (cf. the PLACEMENT property).
Default value	0.