Properties of the PROGRESS 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
_PBA_MOVE	The control moves relative to the window.
_PBA_EXPAND	The control expands of contracts.
_PBA_ANCHOR	The control does not move relative to the window.
_PBA_DEFAULT	Corresponds to the value _PBA_ANCHOR if the control is in a pane located above the bar. Corresponds to the value _PBA_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
_PBA_MOVE	The control moves relative to the window.
_PBA_EXPAND	The control expands of contracts.
_PBA_ANCHOR	The control does not move relative to the window.
_PBA_DEFAULT	Corresponds to the value _PBA_ANCHOR if the control is in a pane located to the left of the bar. Corresponds to the value _PBA_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
_PBA_MOVE	The control moves relative to the window.
_PBA_EXPAND	The control expands of contracts.
_PBA_ANCHOR	The control does not move relative to the window.
_PBA_DEFAULT	Corresponds to the value _PBA_ANCHOR if the control is in a pane located to the left of the bar. Corresponds to the value _PBA_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
_PBA_MOVE	The control moves relative to the window.
_PBA_EXPAND	The control expands of contracts.
_PBA_ANCHOR	The control does not move relative to the window.
_PBA_DEFAULT	Corresponds to the value _PBA_ANCHOR if the control is in a pane located above the bar. Corresponds to the value _PBA_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

Allows the object to be placed in focus. Objects placed in focus are receptive to actions performed by the user using the keyboard and/or mouse.

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

BACKGROUND_COLOR

Color in which the object's background is displayed.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants
_PBA_COL_SYSTEM	"system" color.
_PBA_COL_BLACK	"black" color.
_PBA_COL_BLUE	"blue" color.
_PBA_COL_CYAN	"cyan" color.
_PBA_COL_GREEN	"green" color.
_PBA_COL_MAGENTA	"magenta" color.
_PBA_COL_RED	"red" color.
_PBA_COL_WHITE	"white" color.
_PBA_COL_YELLOW	"yellow" color.
_PBA_COL_DARKBLUE	"dark blue" color.
_PBA_COL_DARKCYAN	"dark cyan" color.
_PBA_COL_DARKGREEN	"dark green" color.
_PBA_COL_PURPLE	"purple" color.
_PBA_COL_DARKRED	"dark red" color.
_PBA_COL_DARKYELLOW	"dark yellow" color.
_PBA_COL_GREY	"grey" color.
_PBA_COL_DARKGREY	"dark grey" color.
Conditions for use	None.
Default value	_PBA_COL_SYSTEM

Note: The BACKGROUND_COLOR property will not be taken into account if the COMCTL32.DLL system file's version is less than 4.71.

DOUBLE_OUTLINES

Specifies the display of a double border.

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

EMBEDDED_OUTLINES

Specifies the display of a border with embedded outlines.

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

GROUP_BEGINNING

Specifies the first object in a group of objects. A group of objects is defined by its first object and all the following objects (following the object sequence) until the first object in another group is reached. The user can use the arrow keys to change focus from one object to another within the same group.

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

HEIGHT

Height value of the object.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	None.
Conditions for use	None.
Default value	30

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
_PBA_ADJUST_EXPAND_WIDTH	The control is expanded width-wise.
_PBA_ADJUST_ALIGNED_LEFT	The control keeps its left side alignment.
_PBA_ADJUST_ALIGNED_RIGHT	The control keeps its right side alignment.
_PBA_ADJUST_ALIGNED_CENTER	The control keeps its center alignment.
_PBA_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	_PBA_ADJUST_ALIGNED_LEFT.

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

INDICATOR_COLOR

Color in which the object's progress bar is displayed.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants
_PBA_COL_SYSTEM	"system" color.
_PBA_COL_BLACK	"black" color.
_PBA_COL_BLUE	"blue" color.
_PBA_COL_CYAN	"cyan" color.
_PBA_COL_GREEN	"green" color.
_PBA_COL_MAGENTA	"magenta" color.
_PBA_COL_RED	"red" color.
_PBA_COL_WHITE	"white" color.
_PBA_COL_YELLOW	"yellow" color.
_PBA_COL_DARKBLUE	"dark blue" color.
_PBA_COL_DARKCYAN	"dark cyan" color.
_PBA_COL_DARKGREEN	"dark green" color.
_PBA_COL_PURPLE	"purple" color.
_PBA_COL_DARKRED	"dark red" color.
_PBA_COL_DARKYELLOW	"dark yellow" color.
_PBA_COL_GREY	"grey" color.
_PBA_COL_DARKGREY	"dark grey" color.
Conditions for use	None.
Default value	_PBA_COL_SYSTEM

Note: The INDICATOR_COLOR property will not be taken into account if the COMCTL32.DLL system file's version is less than 4.71.

INDICATOR_VALUE

Value of the progress indicator. This value will always lie in the range between the values of the properties MIN_VALUE and MAX_VALUE.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	No.
Execution mode	Read / Write.
Associated constants	None.
Conditions for use	None.
Default value	value of the MIN_VALUE property.

Example:

* The progress bar's indicator is incremented at each

* STROKE event of a timer. When the upper limit value

* is reached, then restart at 1.

CALL_METHOD PGB_WAIT INCREMENT_INDICATOR

IF PGB_WAIT:INDICATOR_VALUE = 100

PGB_WAIT:INDICATOR_VALUE = 1

END

MAX_VALUE

Upper limit for the progress bar.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	None.
Conditions for use	None.
Default value	100

MIN_VALUE

Lower limit for the progress bar.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	None.
Conditions for use	None.
Default value	0

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.

ORIENTATION

Specifies the object's orientation.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants
_PBA_ORIENT_HORIZONTAL	Horizontal orientation.
_PBA_ORIENT_VERTICAL	Vertical orientation.
Conditions for use	None.
Default value	_PBA_ORIENT_HORIZONTAL

SMOOTH_INDICATOR_BAR

Sets how the indicator bar is displayed. If this property is set to "*TRUE", the progress bar will be shown as a single rectangle of variable length. If the property is set to "*FALSE", the indicator will appear as a series of rectangles of set length.

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

STATIC_OUTLINES

Specifies the display of a border with static outlines (3D effect used to show objects initially not in focus).

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

STEP_VALUE

Step value used with the INDICATOR_VALUE property when calling the INCREMENT_INDICATOR method.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	None.
Conditions for use	None.
Default value	1

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
_PBA_ADJUST_EXPAND_HEIGHT	The control is extended height-wise.
_PBA_ADJUST_ALIGNED_TOP	The control keeps its top side alignment.
_PBA_ADJUST_ALIGNED_BOTTOM	The control keeps its bottom side alignment.
_PBA_ADJUST_ALIGNED_CENTER	The control keeps its center alignment.
_PBA_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	_PBA_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

Width value of the object.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	None.
Conditions for use	None.
Default value	200

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 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	None.
Default value	None.

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 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	None.
Default value	None.