Properties of the FRAME 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
_FRM_MOVE	The control moves relative to the window.
_FRM_EXPAND	The control expands of contracts.
_FRM_ANCHOR	The control does not move relative to the window.
_FRM_DEFAULT	Corresponds to the value _FRM_ANCHOR if the control is in a pane located above the bar. Corresponds to the value _FRM_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
_FRM_MOVE	The control moves relative to the window.
_FRM_EXPAND	The control expands of contracts.
_FRM_ANCHOR	The control does not move relative to the window.
_FRM_DEFAULT	Corresponds to the value _FRM_ANCHOR if the control is in a pane located to the left of the bar. Corresponds to the value _FRM_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
_FRM_MOVE	The control moves relative to the window.
_FRM_EXPAND	The control expands of contracts.
_FRM_ANCHOR	The control does not move relative to the window.
_FRM_DEFAULT	Corresponds to the value _FRM_ANCHOR if the control is in a pane located to the left of the bar. Corresponds to the value _FRM_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
_FRM_MOVE	The control moves relative to the window.
_FRM_EXPAND	The control expands of contracts.
_FRM_ANCHOR	The control does not move relative to the window.
_FRM_DEFAULT	Corresponds to the value _FRM_ANCHOR if the control is in a pane located above the bar. Corresponds to the value _FRM_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".

ADJUSTMENT_FRAME

When this property equals *TRUE, the frame is made invisible.

This property is useful to define specific adjustments to certain objects encompassed within the frame.

Indeed, when a window's objects are adjusted, objects contained in a frame and whose VERTICAL_ADJUSTMENT AND HORIZONTAL_ADJUSTMENT properties are equal to NONE keep their fixed position in relation to the top left corner of the frame.

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

Note : This property is not implemented by the Java or the Mobile generator.

ALIGNMENT

Defines the alignment used when displaying text inside the frame.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants
_FRM_ALIGN_LEFT	left alignment.
_FRM_ALIGN_CENTER	centered alignment.
_FRM_ALIGN_RIGHT	right alignment.
Conditions for use	none.
Default value	"_FRM_ALIGN_LEFT".

BACKGROUND_COLOR

RGB 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
_FRM_COL_SYSTEM	"system" color.
_FRM_COL_BLACK	"black" color.
_FRM_COL_BLUE	"blue" color.
_FRM_COL_CYAN	"cyan" color.
_FRM_COL_GREEN	"green" color.
_FRM_COL_MAGENTA	"magenta" color.
_FRM_COL_RED	"red" color.
_FRM_COL_WHITE	"white" color.
_FRM_COL_YELLOW	"yellow" color.
_FRM_COL_DARKBLUE	"dark blue" color.
_FRM_COL_DARKCYAN	"dark cyan" color.
_FRM_COL_DARKGREEN	"dark green" color.
_FRM_COL_PURPLE	"purple" color.
_FRM_COL_DARKRED	"dark red" color.
_FRM_COL_DARKYELLOW	"dark yellow" color.
_FRM_COL_GREY	"grey" color.
_FRM_COL_DARKGREY	"dark grey" color.
Conditions for use	The OVERLAP property of the object must be set to *FALSE.
Default value	"_FRM_COL_SYSTEM".

Note: This property is not implemented by the Java generator.

FLAT

The object has a two-dimensional visual appearance if this property is set to True.

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

Note: This property is not implemented in Mobile generation.

FONT

Character font used to display the text in the object.

The string format contains the name, size, style and script, in that order. A semi-colon must be inserted between each element.

If you set a property's value, you MUST specify the name and size.

The different styles are specified using the following values:

- 1: Normal (no special style)
- 2: Strikethrough
- 16: Italics
- 256: Bold
- 4096: Underlined

The style value to be specified in the string can either be one of the above values or else the sum of values other than 1.

The different script values are as follows:

0	Occidental (ANSI)
1	Default value (current value for the process)
2	Symbol
128	Japanese (Shift JIS)
129	Hangul Korean
130	Johab Korean
134	Simplified chinese GB2312
136	Traditional chinese (Big 5)
161	Greek
162	Turkish
163	Vietnamese
177	Hebrew
178	Arab
186	Baltic
204	Cyrillic
222	Thai
238	Central Europe
255	OEM/DOS

Adelia type	ALPHA(250).
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	none.
Conditions for use	none.
Default value	"MS Sans Serif;8;1;0".

Notes:

The size, style and script must be compatible with the chosen font. The Windows system font selection dialog box, accessible via the graphical object's Properties pages, provides a guide for selecting coherent values.

The "Underlined" style is not considered by the Java generator.

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	"65".

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
_FRM_ADJUST_EXPAND_WIDTH	The control is expanded width-wise.
_FRM_ADJUST_ALIGNED_LEFT	The control keeps its left side alignment.
_FRM_ADJUST_ALIGNED_RIGHT	The control keeps its right side alignment.
_FRM_ADJUST_ALIGNED_CENTER	The control keeps its center alignment.
_FRM_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	_FRM_ADJUST_ALIGNED_LEFT.

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

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.

OVERLAP

Authorizes the image object to draw itself over a control positioned in front of it in the window object order.

When this property is set to *TRUE, the object background is transparent.

The transparency applies to the frame text only if the support for Windows themes is active.

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

For more information about managing overlapping of graphical objects, consult the working with object overlap section.

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

SOLID

When the property's value is det to *TRUE, the background color is applied to the entire surface of the object, otherwise it is only applied to the frame around the object's text.

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

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

TEXT

String of characters displayed inside the object.

The text is displayed on a single line.

Adelia type	ALPHA(250).
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants	none.
Conditions for use	none.
Default value	"Title".

TEXT_COLOR

RGB color in which the text in the object is displayed.

Adelia type	NUM_BIN_4.
Accessibility
Layout design mode	Read / Write.
Execution mode	Read / Write.
Associated constants
_FRM_COL_SYSTEM	"system" color.
_FRM_COL_BLACK	"black" color.
_FRM_COL_BLUE	"blue" color.
_FRM_COL_CYAN	"cyan" color.
_FRM_COL_MAGENTA	"magenta" color.
_FRM_COL_RED	"red" color.
_FRM_COL_WHITE	"white" color.
_FRM_COL_YELLOW	"yellow" color.
_FRM_COL_DARKBLUE	"dark blue" color.
_FRM_COL_DARKCYAN	"dark cyan" color.
_FRM_COL_DARKGREEN	"dark green" color.
_FRM_COL_PURPLE	"purple" color.
_FRM_COL_DARKRED	"dark red" color.
_FRM_COL_DARKYELLOW	"dark yellow" color.
_FRM_COL_GREY	"grey" color.
_FRM_COL_DARKGREY	"dark grey" color.
Conditions for use	none.
Default value	"_FRM_COL_SYSTEM".

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
_FRM_ADJUST_EXPAND_HEIGHT	The control is extended height-wise.
_FRM_ADJUST_ALIGNED_TOP	The control keeps its top side alignment.
_FRM_ADJUST_ALIGNED_BOTTOM	The control keeps its bottom side alignment.
_FRM_ADJUST_ALIGNED_CENTER	The control keeps its center alignment.
_FRM_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	_FRM_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	"72".

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.