This method allows the sequence number of a column to be retrieved. It is useful for storing the sequence chosen by the user, in order to reproduce it the next time it is run.
The columns are numbered from 1 upwards, irrespective of their visibility.
| Syntax | |||||
CALL_METHOD ColumnName GET_COLUMN_NUMBER SequenceNumber ReturnCode |
|||||
Parameters |
|||||
NUM_BIN_4 SequenceNumber (O) |
Column sequence number. |
||||
NUM_BIN_4 ReturnCode (O) |
Return code for the operation. Possible values:
|
||||
Conditions for use |
None |
||||
Note: This method is not used by the Java generator.
Locates the first and last selected character in the cell's input field.
| Syntax | |||||||
CALL_METHOD ColumnObjectName GET_CURSOR_LOCATION LineNum StartPosition EndPosition ReturnCode |
|||||||
Parameters |
|||||||
NUM_BIN_4 LineNum (O) |
Line number, |
||||||
NUM_BIN_4 StartPosition (O) |
Position of the first selected character, |
||||||
NUM_BIN_4 EndPosition (O) |
Position of the first character after the last selected character, |
||||||
NUM_BIN_2 ReturnCode (O) |
Return code for the operation. Possible values:
|
||||||
Conditions for use |
None |
||||||
Note: This method is not implemented by the Java generator.
Used to retrieve the keyboard keys which were defined when the previous GET_MOUSE_EVT_KEY method was called and which were in the "pressed" state during the last mouse event on the Column object.
| Syntax | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CALL_METHOD ColumnObjectName GET_MOUSE_EVT_KEYS ShiftKeyState CtrlKeyState AltKeyState AlphaNumArray OtherKeysArray OtherKeysArraySize ReturnCode |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameters |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BOOL |
ShiftKeyState (O) |
ShiftKeyState Returns *True if the 'Shift' key was in "pressed" state during the last mouse event on the Column object. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BOOL |
CtrlKeyState (O) |
Returns *True if the 'Ctrl' key was in "pressed" state during the last mouse event on the Column object. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BOOL |
AltKeyState (O) |
Returns *True if the 'Alt' key was in "pressed" state during the last mouse event on the Column object. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ALPHA(36) |
AlphaNumArray (O) |
Alphanumeric variable containing the alphanumeric A to Z keys and numeric keys 0 to 9 which were in "pressed" state during the last mouse event on the Column object. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NUM_BIN_2 array |
OtherKeysArray (O) |
Array containing the other keys which were in "pressed" state during the last mouse event on the Column object.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NUM_BIN_2 |
OtherKeysArraySize (I/O) |
As an input: OtherKeysArray array size. As an output: number of keys in pressed state retrieved in the OtherKeysArray array. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NUM_BIN_2 |
ReturnCode (O) |
Return code of the operation. Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Conditions for use |
The SET_MOUSE_EVT_KEYS method must be called beforehand. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The length of the OtherKeysArray array must be at least the specified size.
The value of ShiftKeyState and CtrKeyState parameters is set to *True when the left or right Shift key and left or right Ctrl key respectively are in "pressed" state.
It is possible to differentiate between left and right keys using the values _COL_VIRTUAL_KEY_SHIFT_L and _COL_VIRTUAL_KEY_SHIFT_R for the Shift key and _COL_VIRTUAL_KEY_CTRL_L and _COL_VIRTUAL_KEY_CTRL_R for the Ctrl key in the OtherKeysTab parameter.
If the Alt Gr key is in "pressed" state, the value of AltKeyState and CtrlKeyState parameters is set to *True.
Notes:
This method is not implemented by the Java generator.
It is not available in Mobile generation.
Sets the column's filter field to "*" and resets the INTERNAL_FILTER_VALUE property.
| Syntax | |||||
CALL_METHOD NameColumnObject INITIALIZE_FILTER_FIELD ReturnCode |
|||||
Parameters |
|||||
NUM_BIN_4 ReturnCode (O) |
Return code for the operation. Possible values:
|
||||
Conditions for use |
None |
||||
This method allows the sequence number of a column to be set. It is useful for retrieving the sequence a user has set during a previous run.
The columns are numbered from 1 upwards, irrespective of their visibility.
| Syntax | |||||||||||
CALL_METHOD ColumnName SET_COLUMN_NUMBER SequenceNumber ReturnCode |
|||||||||||
Parameters |
|||||||||||
NUM_BIN_4 SequenceNumber (I) |
Column sequence number. |
||||||||||
NUM_BIN_4 ReturnCode (O) |
Return code for the operation. Possible values:
|
||||||||||
Conditions for use |
None |
||||||||||
Notes:
This method must be used, starting with the value 1 (or the number of columns) to obtain the desired overall sequence.
This method is not implemented by the Java generator.
Selects a block of characters in the cell's input field.
| Syntax | |||||||||
CALL_METHOD ColumnObjectName SET_CURSOR_LOCATION LineNum StartPosition EndPosition ReturnCode |
|||||||||
Parameters |
|||||||||
NUM_BIN_4 LineNum (I) |
Line number. |
||||||||
NUM_BIN_4 StartPosition (I) |
Position of the first character that you want to select. If StartPosition is set to -1 the text is deselected and the cursor moves to the end of the line. |
||||||||
NUM_BIN_4 EndPosition (I) |
Position of the first character following the last character that you want to select. If EndPosition is set to -1 the complete text is selected. |
||||||||
NUM_BIN_2 ReturnCode (O) |
Return code for the operation. Possible values:
|
||||||||
Conditions for use |
None |
||||||||
Note: This method is not implemented by the Java generator.
Places the focus on the object.
| Syntax | |
CALL_METHOD NameColumnObject SET_FOCUS NumLine |
|
Parameter |
|
NumLine |
NUM_BIN_4 type |
Conditions for use |
None (property applicable to all elements in the object). |
Note: This method is only effective for columns that are not in read-only mode.
Used to define the keyboard keys for which it is desired to retrieve the state (pressed/released) during Column object mouse events.
This method must be used before calling the GET_MOUSE_EVT_KEYS method of the same object.
| Syntax | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CALL_METHOD ColumnObjectName SET_MOUSE_EVT_KEYS TestShiftKey TestCtrlKey TestAltKey AlphaNumArray OtherKeysArray OtherKeysArraySize ReturnCode |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameters |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BOOL |
TestShiftKey (I) |
Indicates if the 'Shift' key state needs to be tested when calling the GET_MOUSE_EVT_KEYS method. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BOOL |
TestCtrlKey (I) |
Indicates if the 'Ctrl' key state needs to be tested when calling the GET_MOUSE_EVT_KEYS method. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BOOL |
TestAltKey (I) |
Indicates if the 'Alt' key state needs to be tested when calling the GET_MOUSE_EVT_KEYS method. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ALPHA(36) |
AlphaNum (I) |
String containing alphanumeric characters A to Z and numeric characters 0 to 9 representing the keyboard keys that must be tested when calling the GET_MOUSE_EVT_KEYS method. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NUM_BIN_2 array |
OtherKeysArray (I) |
Array containing the values representing the other keyboard keys that must be tested when calling the GET_MOUSE_EVT_KEYS method. The values corresponding to the keys are indicated below.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NUM_BIN_2 |
OtherKeysArraySize (I) |
Number of elements inserted into the OtherKeysArray array. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NUM_BIN_2 |
ReturnCode (O) |
Return code of the operation. Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Conditions for use |
None |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The length of the OtherKeysArray array must be at least the specified size.
If the AlphaNumArray array is empty, the A->Z and 0->9 keys will not be tested the next time the GET_MOUSE_EVT_KEYS method is called.
Similarly, if the OtherKeysArraySize parameter is equal to 0 the "other" keys will not be tested the next time the GET_MOUSE_EVT_KEYS method is called.
Notes:
This method is not implemented by the Java generator.
It is not available in Mobile generation.
Triggers the FilterAction event.
| Syntax | |||||
CALL_METHOD NameColumnObject TRIGGER_FILTER_ACTION InternalFilterValue ExternalFilterValue ReturnCode |
|||||
Parameters |
|||||
Alpha(250) InternalFilterValue (I) |
Value that will be assigned to the INTERNAL_FILTER_VALUE property. |
||||
Alpha(250) ExternalFilterValue (I) |
Value that will appear in the context-sensitive menu of the selected filters. |
||||
NUM_BIN_4 ReturnCode (O) |
Return code for the operation. Possible values:
|
||||
Conditions for use |
The FILTER property must be set to _COL_MANUAL_FILTER. |
||||