Code wiki

Directions assigned to method parameters:

(I)	Input
(O)	Output
(I/O)	Input and Output

List of the return codes for the various methods:

_WIN_ERR_OK	1	Operation completed successfully.
_WIN_ERR_EXEC	0	An unexpected error occurred.
_WIN_ERR_PAGE	-1	Incorrect PageNum parameter value.
_WIN_ERR_VISIBLE_PAGE	-2	The specified page cannot be made invisible because it is the only visible page.
_WIN_ERR_WIN_TYPE	-2	The window is not the right type (basic window or tab window) for the method.
_WIN_ERR_WIN_TYPE2	-3	The window is not the right type (basic window or tab window) for the method.
_WIN_ERR_WIN_CLS	-4	The window is not the right class for the method.
_WIN_ERR_PARAM	-5	An input parameter has an invalid value.
_WIN_ERR_CHILD_TERM	-6	One or more child windows cannot be terminated (happens when the user has opened a modal window from a child window).

Activates a main window's next child window.

Syntax
CALL_METHOD WindowName ACTIVATE_NEXT_WIN ReturnCode
Parameters
ReturnCode (O)	NUM_BIN_2	Return code for the operation. Possible values: _WIN_ERR_OK _WIN_ERR_WIN_CLS
Conditions for use		The window must be a main window.

Note: This method is not implemented in Mobile generation.

Arranges any child windows displayed as icons in the bottom left corner of a main window's client area.

Syntax
CALL_METHOD WindowName ARRANGE_ICONS ReturnCode
Parameters
ReturnCode (O)	NUM_BIN_2	Return code for the operation. Possible values: _WIN_ERR_OK _WIN_ERR_WIN_CLS
Conditions for use		The window must be a main window.

Note: This method is not implemented in Mobile and Cloud generation.

Closes all the child windows in a main window. This amounts to running a TERMINATE instruction for each child window.

Syntax
CALL_METHOD WindowName CLOSE_ALL ReturnCode
Parameters
ReturnCode (O)	NUM_BIN_2	Return code for the operation. Possible values: _WIN_ERR_OK _WIN_ERR_WIN_CLS _WIN_ERR_CHILD_TERM
Conditions for use		The window must be a main window.

Note: This method is not implemented in Mobile and Cloud generation.

Displays a main window's child windows in cascade format.

Syntax

CALL_METHOD WindowName DISPLAY_CASCADE Type ReturnCode

Parameters

Type (I)

NUM_BIN_2

Defines the set of child windows to be cascaded.

Possible values:

_WIN_DISPLAY_ALL	All the child windows are displayed in a cascade.
_WIN_DISPLAY_ACTIVE	Only the active child windows are displayed in a cascade.

ReturnCode (O)

NUM_BIN_2

Return code for the operation.

Possible values:

_WIN_ERR_OK

_WIN_ERR_WIN_CLS

_WIN_ERR_PARAM

Conditions for use

The window must be a main window.

Note: This method is not implemented in Mobile generation.

Displays a main window's child windows in tiled format.

Syntax

CALL_METHOD WindowName DISPLAY_TILE Type ReturnCode

Parameters

Type (I)

NUM_BIN_2

Defines the set of child windows to be tiled, and specifies their orientation.

Possible values:

_WIN_DISPLAY_HORZ	The various child windows are displayed as horizontal strips placed one below the other.
_WIN_DISPLAY_VERT	The various child windows are displayed as juxtaposed vertical strips.
_WIN_DISPLAY_ACTIVE	This constant can be added to the above parameters so that only the active windows are affected by the procedure.

ReturnCode (O)

NUM_BIN_2

Return code for the operation.

Possible values:

_WIN_ERR_OK

_WIN_ERR_WIN_CLS

_WIN_ERR_PARAM

Conditions for use

The window must be a main window.

Note: This method is not implemented in Mobile generation.

Retrieves the mouse cursor coordinates, relative to the area covered by the window.

Syntax
CALL_METHOD WindowObjectName GET_CURSOR_POSITION XAxis YAxis ReturnCode
Parameters
Xaxis (O)	NUM_BIN_4	X-axis value of the cursor relative to the top left corner of the window.
Yaxis (O)	NUM_BIN_4	Y-axis value of the cursor relative to the top left corner of the window.
ReturnCode (O)	BOOL	TRUE: operation successful. FALSE: failed.
Conditions for use		None

Collects the names of graphical objects on a page, in the margin or in the whole window in an array.

The array is sorted according to the order of graphical objects in the window.

Syntax

CALL_METHOD WindowName GET_OBJECTS ObjectNameArray Size ObjectClass PageNum NumberElementsRead ReturnCode

Parameters

ObjectNameArray (O)

ALPHA(128)

Array receiving as an output the names of graphical objects in the window.

Size (I)

NUM_BIN_4

Size of the ObjectNameArray array.

ObjectClass (I)

ALPHA(250)

Basic graphical object file name. It is defined in the Change a basic graphical object box of the basic graphical object.

PageNum (I)

NUM_BIN_2

Page number. This is the sequence number of the page when all pages are visible.

_WIN_DISPLAY_HORZ	The various child windows are displayed as horizontal strips placed one below the other.
_WIN_DISPLAY_VERT	The various child windows are displayed as juxtaposed vertical strips.
_WIN_DISPLAY_ACTIVE	This constant can be added to the above parameters so that only the active windows are affected by the procedure.

NumberElementsRead (O)

NUM_BIN_4

Number of elements inserted into the array.

ReturnCode (O)

NUM_BIN_2

Return code for the operation.

Possible values:

_WIN_ERR_OK

_WIN_ERR_PAGE

_WIN_ERR_PARAM

_WIN_ERR_EXEC

_WIN_ERR_WIN_TYPE

Conditions for use

The window must not be a main window.

Notes:

The length of the ObjectNameArray must be at least the specified size.

If there are more objects than the specified size, the return code will have the value _WIN_ERR_PARAM but the array will be filled.

Example of use: The names of retrieved objects may be used by the predefined &GET_OBJECT function to manipulate the object properties.

Note: This method is not used by the Java generator.

Retrieves the activity of a page in a tabbed window.

Syntax
CALL_METHOD WindowName GET_PAGE_ACTIVITY PageNum Activity ReturnCode
Parameters
PageNum (I)	NUM_BIN_2	Page number. This is the sequence number of the page when all pages are visible.
Activity (O)	BOOL	Page activity.
ReturnCode (O)	NUM_BIN_2	Return code for the operation. Possible values: _WIN_ERR_OK _WIN_ERR_PAGE _WIN_ERR_WIN_TYPE _WIN_ERR_WIN_CLS
Conditions for use		The window must be a tabbed window.

Note: This method is not used by the Java generator.

Retrieves the text of a tab on a page in a tabbed window.

Syntax
CALL_METHOD WindowName GET_PAGE_TEXT PageNum Text ReturnCode
Parameters
PageNum (I)	NUM_BIN_2	Page number. This is the sequence number of the page when all pages are visible.
Text (O)	ALPHA(250)	Text of the tab on the page.
ReturnCode (O)	NUM_BIN_2	Return code for the operation. Possible values: _WIN_ERR_OK _WIN_ERR_EXEC _WIN_ERR_PAGE _WIN_ERR_WIN_TYPE _WIN_ERR_WIN_CLS
Conditions for use		The window must be a tabbed window.

Retrieves the visibility of a page in a tabbed window.

Syntax
CALL_METHOD WindowName GET_PAGE_VISIBILITY PageNum Visibility ReturnCode
Parameters
PageNum (I)	NUM_BIN_2	Page number. This is the sequence number of the page when all pages are visible.
Visibility (O)	BOOL	Page visibility.
ReturnCode (O)	NUM_BIN_2	Return code for the operation. Possible values: _WIN_ERR_OK _WIN_ERR_EXEC _WIN_ERR_PAGE _WIN_ERR_WIN_TYPE _WIN_ERR_WIN_CLS
Conditions for use		The window must be a tabbed window.

Specifies a page's activity in a tabbed window. When a page is inactive, it cannot be accessed via the interface. It is possible, however, to bring it to the foreground by programming it to do so.

Syntax
CALL_METHOD WindowName SET_PAGE_ACTIVITY PageNum Activity ReturnCode
Parameters
PageNum (I)	NUM_BIN_2	Page number. This is the sequence number of the page when all pages are visible.
Activity (I)	BOOL	Page activity.
ReturnCode (O)	NUM_BIN_2	Return code for the operation. Possible values: _WIN_ERR_OK _WIN_ERR_PAGE _WIN_ERR_WIN_TYPE _WIN_ERR_WIN_CLS
Conditions for use		The window must be a tabbed window.

Note: This method is not used by the Java generator.

Specifies the text of a tab on a page in a tabbed window.

Syntax
CALL_METHOD WindowName SET_PAGE_TEXT PageNum Text ReturnCode
Parameters
PageNum (I)	NUM_BIN_2	Page number. This is the sequence number of the page when all pages are visible.
Text (I)	ALPHA(250)	Text of the tab on the page.
ReturnCode (O)	NUM_BIN_2	Return code for the operation. Possible values: _WIN_ERR_OK _WIN_ERR_EXEC _WIN_ERR_PAGE _WIN_ERR_WIN_TYPE _WIN_ERR_WIN_CLS
Conditions for use		The window must be a tabbed window.

Specifies the visibility of a page in a tabbed window. If the current page becomes invisible, the next visible page becomes the new current page.

Syntax
CALL_METHOD WindowName SET_PAGE_VISIBILITY PageNum Visibility ReturnCode
Parameters
PageNum (I)	NUM_BIN_2	Page number. This is the sequence number of the page when all pages are visible.
Visibility (I)	BOOL	Page visibility.
ReturnCode (O)	NUM_BIN_2	Return code for the operation. Possible values: _WIN_ERR_OK _WIN_ERR_EXEC _WIN_ERR_PAGE _WIN_ERR_VISIBLE_PAGE _WIN_ERR_WIN_TYPE2 _WIN_ERR_WIN_CLS
Conditions for use		The window must be a tabbed window.