Methods of the SPLIT BAR Object

List of return codes for the various methods

_SPLT_ERR_OK	Method run successfully.
_SPLT_PARAM_ERR	One or more invalid parameters.
_SPLT_TYPE_ERR	One or more of the method's variables is the wrong Adelia type.
_SPLT_ERR_EXEC	Anomaly during execution (this should never happen).
_SPLT_ERR_STRING_LENGTH	The method must return a character string longer than the Adelia variable.
_SPLT_ERR_MIN_SPACE_EXCEED	The method was unable to place the bar at the specified position as the minimum space for one of the views is not respected.
_SPLT_ERR_INVALID_MIN_SPACE	The method could not allocate the specified minimum space to the view.

GET_PANE_ACTIVITY

Retrieves the activity of a division's pane.

Syntax
CALL_METHOD SplitBarObjectName GET_PANE_ACTIVITY DivisionName PaneNumber Activity ReturnCode
Parameters
DivisionName(E)	ALPHA(30)	Name of the division.
PaneNumber(E)	NUM_BIN_2	Pane number.
Activity(S)	BOOL	Pane activity.
ReturnCode(S)	NUM_BIN_4	Method's return code. Possible values : _SPLT_ERR_OK _SPLT_PARAM_ERR

GET_PANE_BACKGROUND_COLOR

Retrieves the background color or a division pane.

Syntax

CALL_METHOD SplitBarObjectName GET_PANE_BACKGROUND_COLOR DivisionName PaneNum Color ReturnCode

Parameters

DivisionName(E)

ALPHA(30)

Name of the division.

PaneNumber(E)

NUM_BIN_2

Pane number.

Color(E)

NUM_BIN_4

Color.

Possible values:

_SPLT_COL_SYSTEM	System color,
_SPLT_COL_BLACK	Black color,
_SPLT_COL_BLUE	Blue color,
_SPLT_COL_CYAN	Cyan color,
_SPLT_COL_GREEN	Green color,
_SPLT_COL_MAGENTA	Magenta color,
_SPLT_COL_RED	Red color,
_SPLT_COL_WHITE	White color,
_SPLT_COL_YELLOW	Yellow color,
_SPLT_COL_DARKBLUE	Dark blue color,
_SPLT_COL_DARKCYAN	Dark cyan color,
_SPLT_COL_DARKGREEN	Dark green color,
_SPLT_COL_PURPLE	Purple color,
_SPLT_COL_DARKRED	Dark red color,
_SPLT_COL_DARKYELLOW	Dark yellow color,
_SPLT_COL_GREY	Grey color,
_SPLT_COL_DARKGREY	Dark grey color.

ReturnCode (O)

NUM_BIN_4

Method's return code.

Possible values:

_SPLT_ERR_OK

_SPLT_PARAM_ERR

GET_PANE_MIN

Retrieves the minimum space of a division pane.

Syntax
CALL_METHOD SplitBarObjectName GET_PANE_MIN DivisionName PaneNum PaneWidth ReturnCode
Parameters
DivisionName(E)	ALPHA(30)	Name of the division.
PaneNum(E)	NUM_BIN_2	Pane number.
PaneWidth(E)	NUM_BIN_4	Minimum pane space.
ReturnCode(S)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR

GET_PANE_SCROLL_BAR_VISIBILITY

Retrieves the visibility status of the vertical and horizontal scrollbars of a division pane, when the size of the pane is reduced from its initial size.

Syntax
CALL_METHOD SplitBarObjectName GET_PANE_SCROLL_BAR_VISIBILITY DivisionName PaneNumber ScrollBarVisible ReturnCode
Parameters
DivisionName(E)	ALPHA(30)	Name of the division.
PaneNumber(E)	NUM_BIN_2	Pane number.
ScrollBarVisible(S)	BOOL	Vertical and horizontal scroll bar visibility.
ReturnCode(S)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR

GET_PANE_VISIBILITY

Retrieves a pane's visibility status. A pane is invisible if the split bar completely hides the pane.

Syntax
CALL_METHOD SplitBarObjectName GET_PANE_VISIBILITY DivisionName PaneNumber Visible ReturnCode
Parameters
DivisionName(E)	ALPHA(30)	Name of the division.
PaneNumber(E)	NUM_BIN_2	Pane number.
Visible(S)	BOOL	Pane visibility.
ReturnCode(S)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR

GET_SPLITTER_BUTTON

Retrieves the type of the button displayed on the split bar.

Syntax
CALL_METHOD SplitBarObjectName GET_SPLITTER_BUTTON DivisionName Button ReturnCode
Parameters
DivisionName(I)	ALPHA(30)	Name of the division.
Button(I)	NUM_BIN_2	Type of the button displayed on the split bar. Possible values: 0: No button is displayed. 1: Button to reduce the view down or to the right. 2: Button to reduce the view up or to the left.
ReturnCode (O)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR

GET_SPLITTER_COLOR

Retrieves the color of the split bar.

Syntax

CALL_METHOD SplitBarObjectName GET_SPLITTER_COLOR DivisionName Color ReturnCode

Parameters

DivisionName(I)

ALPHA(30)

Name of the division.

Color(I)

NUM_BIN_4

Color

Possible values:

_SPLT_COL_SYSTEM	System color,
_SPLT_COL_BLACK	Black color,
_SPLT_COL_BLUE	Blue color,
_SPLT_COL_CYAN	Cyan color,
_SPLT_COL_GREEN	Green color,
_SPLT_COL_MAGENTA	Magenta color,
_SPLT_COL_RED	Red color,
_SPLT_COL_WHITE	White color,
_SPLT_COL_YELLOW	Yellow color,
_SPLT_COL_DARKBLUE	Dark blue color,
_SPLT_COL_DARKCYAN	Dark cyan color,
_SPLT_COL_DARKGREEN	Dark green color,
_SPLT_COL_PURPLE	Purple color,
_SPLT_COL_DARKRED	Dark red color,
_SPLT_COL_DARKYELLOW	Dark yellow color,
_SPLT_COL_GREY	Grey color,
_SPLT_COL_DARKGREY	Dark grey color.

ReturnCode (O)

NUM_BIN_4

Method's return code.

Possible values:

_SPLT_ERR_OK

_SPLT_PARAM_ERR

GET_SPLITTER_MOVE

Determines whether a split bar can be moved with the mouse.

Syntax
CALL_METHOD SplitBarObjectName GET_SPLITTER_MOVE DivisionName Move ReturnCode
Parameters
DivisionName(I)	ALPHA(30)	Name of the division.
Move(E)	BOOL	Bar movement.
ReturnCode (O)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR

GET_SPLITTER_ORIENTATION

Retrieves the horizontal or vertical orientation of the bar in a division.

Syntax
CALL_METHOD SplitBarObjectName GET_SPLITTER_ORIENTATION DivisionName Orientation ReturnCode
Parameters
DivisionName(E)	ALPHA(30)	Name of the division.
Orientation(S)	NUM_BIN_2	Vertical or horizontal orientation of the bar. Possible values: _SPLT_ORIENT_HORIZONTAL _SPLT_ORIENT_VERTICAL
ReturnCode (S)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR

GET_SPLITTER_POSITION

Retrieves the position of the bar in a division. The reference point is the top left-hand corner of the division.

Syntax
CALL_METHOD SplitBarObjectName GET_SPLITTER_POSITION DivisionName Position ReturnCode
Parameters
DivisionName(E)	ALPHA(30)	Name of the division.
Position(E)	NUM_BIN_4	X or Y coordinates of the bar relative to the division.
ReturnCode (S)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR _SPLT_ERR_MIN_SPACE_EXCEED

GET_SPLITTER_WIDTH

Retrieves the width of a division's split bar.

Syntax
CALL_METHOD SplitBarObjectName GET_SPLITTER_WIDTH DivisionName SpltWidth ReturnCode
Parameters
DivisionName(E)	ALPHA(30)	Name of the division.
SpltWidth(E)	NUM_BIN_2	Bar width.
ReturnCode (S)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR

SET_PANE_ACTIVITY

Enables or disables a given pane. If the pane is disabled, it does not react to the user's keyboard or mouse actions. Any controls placed in the pane are also disabled.

Syntax
CALL_METHOD SplitBarObjectName SET_PANE_ACTIVITY DivisionName PaneNum Activity ReturnCode
Parameters
DivisionName(E)	ALPHA(30)	Name of the division.
PaneNumber(E)	NUM_BIN_2	Pane number.
Activity(E)	BOOL	Pane activity.
ReturnCode (O)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR

SET_PANE_BACKGROUND_COLOR

Defines the background color or a division pane.

Syntax

CALL_METHOD SplitBarObjectName SET_PANE_BACKGROUND_COLOR DivisionName PaneNum Color ReturnCode

Parameters

DivisionName(E)

ALPHA(30)

Name of the division.

PaneNumber(E)

NUM_BIN_2

Pane number.

Color(E)

NUM_BIN_4

Color.

Possible values:

_SPLT_COL_SYSTEM	System color,
_SPLT_COL_BLACK	Black color,
_SPLT_COL_BLUE	Blue color,
_SPLT_COL_CYAN	Cyan color,
_SPLT_COL_GREEN	Green color,
_SPLT_COL_MAGENTA	Magenta color,
_SPLT_COL_RED	Red color,
_SPLT_COL_WHITE	White color,
_SPLT_COL_YELLOW	Yellow color,
_SPLT_COL_DARKBLUE	Dark blue color,
_SPLT_COL_DARKCYAN	Dark cyan color,
_SPLT_COL_DARKGREEN	Dark green color,
_SPLT_COL_PURPLE	Purple color,
_SPLT_COL_DARKRED	Dark red color,
_SPLT_COL_DARKYELLOW	Dark yellow color,
_SPLT_COL_GREY	Grey color,
_SPLT_COL_DARKGREY	Dark grey color.

ReturnCode (O)

NUM_BIN_4

Method's return code.

Possible values:

_SPLT_ERR_OK

_SPLT_PARAM_ERR

SET_PANE_MIN

Defines the minimum space for a division pane, hence the limit beyond which the user can no longer drag the bar with the mouse.

The size of the pane is always greater than or equal to the minimum space. Consequently, calling this method may result in the movement of the bar.

Syntax
CALL_METHOD SplitBarObjectName SET_PANE_MIN DivisionName PaneNum PaneWidth ReturnCode
Parameters
DivisionName(E)	ALPHA(30)	Name of the division.
PaneNum(E)	NUM_BIN_2	Pane number.
PaneWidth(E)	NUM_BIN_4	Minimum pane space.
The method fails, returning the code _SPLT_ERR_INVALID_MIN_SPACE in the following situations: When the total of the minimum spaces of the division's two panes is greater than the size of the division. When the minimum space of the pane that you are attempting to set is greater than the size of the division to which it belongs. When the minimum space that you are setting is less than the total of the minimum spaces of the division panes interleaved in its pane 'PaneNumber' with the same orientation.
ReturnCode(S)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR _SPLT_ERR_INVALID_MIN_SPACE

SET_PANE_SCROLL_BAR_VISIBILITY

Set the visibility of the vertical and horizontal scrollbars of a division pane.

Syntax
CALL_METHOD SplitBarObjectName SET_PANE_SCROLL_BAR_VISIBILITY DivisionName PaneNumber ScrollBarVisible ReturnCode
Parameters
DivisionName(E)	ALPHA(30)	Name of the division.
PaneNumber(E)	NUM_BIN_2	Pane number.
ScrollBarVisible(S)	BOOL	Vertical and horizontal scroll bar visibility.
ReturnCode(S)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR

SET_SPLITTER_BUTTON

Manages the display of a button on the split bar.

This button allows either to reduce the view down/to the right, or to reduce the view up/to the left.

Syntax
CALL_METHOD SplitBarObjectName SET_SPLITTER_BUTTON DivisionName Button ReturnCode
Parameters
DivisionName(I)	ALPHA(30)	Name of the division.
Button(I)	NUM_BIN_2	Type of the button to display on the split bar. Possible values: 0: No button is displayed. 1: Button to reduce the view down or to the right. 2: Button to reduce the view up or to the left.
ReturnCode (S)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR

SET_SPLITTER_COLOR

Sets the color of the split bar.

Syntax

CALL_METHOD SplitBarObjectName SET_SPLITTER_COLOR DivisionName Color ReturnCode

Parameters

DivisionName(I)

ALPHA(30)

Name of the division.

Color(I)

NUM_BIN_4

Color

Possible values:

_SPLT_COL_SYSTEM	System color,
_SPLT_COL_BLACK	Black color,
_SPLT_COL_BLUE	Blue color,
_SPLT_COL_CYAN	Cyan color,
_SPLT_COL_GREEN	Green color,
_SPLT_COL_MAGENTA	Magenta color,
_SPLT_COL_RED	Red color,
_SPLT_COL_WHITE	White color,
_SPLT_COL_YELLOW	Yellow color,
_SPLT_COL_DARKBLUE	Dark blue color,
_SPLT_COL_DARKCYAN	Dark cyan color,
_SPLT_COL_DARKGREEN	Dark green color,
_SPLT_COL_PURPLE	Purple color,
_SPLT_COL_DARKRED	Dark red color,
_SPLT_COL_DARKYELLOW	Dark yellow color,
_SPLT_COL_GREY	Grey color,
_SPLT_COL_DARKGREY	Dark grey color.

ReturnCode (O)

NUM_BIN_4

Method's return code.

Possible values:

_SPLT_ERR_OK

_SPLT_PARAM_ERR

SET_SPLITTER_MOVE

Determines whether a split bar can be moved with the

Syntax
CALL_METHOD SplitBarObjectName SET_SPLITTER_MOVE DivisionName Move ReturnCode
Parameters
DivisionName(I)	ALPHA(30)	Name of the division.
Move(I)	BOOL	Bar movement.
ReturnCode (O)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR

SET_SPLITTER_POSITION

Sets the position of a division's split bar. The reference point is the top left-hand corner of the division.

Syntax
CALL_METHOD SplitBarObjectName SET_SPLITTER_POSITION DivisionName Position ReturnCode
Parameters
DivisionName(I)	ALPHA(30)	Name of the division.
Position(I)	NUM_BIN_4	X or Y coordinates of the bar relative to the division. If Position is equal to _SPLT_MAX_POSITION, the bar is positioned to the far right or at the bottom. If Position overlaps on the minimum space of one of the division's two views, the method returns the _SPLT_ERR_MIN_SPACE_EXCEED code ans sets the bar at the limit of the minimum space. Possible value: _SPLT_MAX_POSITION
ReturnCode (O)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR _SPLT_ERR_MIN_SPACE_EXCEED

SET_SPLITTER_WIDTH

Sets the width of a division's split bar.

Syntax
CALL_METHOD SplitBarObjectName SET_SPLITTER_WIDTH DivisionName SpltWidth ReturnCode
Parameters
DivisionName(E)	ALPHA(30)	Name of the division.
SpltWidth(E)	NUM_BIN_2	Bar width.
ReturnCode (S)	NUM_BIN_4	Method's return code. Possible values: _SPLT_ERR_OK _SPLT_PARAM_ERR