Text Entry: _getCurcol

Text Entry: _getCurcol

Returns the position of the text cursor relative to the first column of a text entry field

Syntax
Details
Examples

Syntax

CALL NOTIFY ('text-field-name, '_getCurcol', column);

Argument Description

column
returns the cursor position relative to the field's first column:

>0 the number of columns to the right of the field's first column plus 1

<=0 the absolute number of columns to the left of the field's first column minus 1

Argument	Description
column	returns the cursor position relative to the field's first column:
		>0	the number of columns to the right of the field's first column plus 1
		<=0	the absolute number of columns to the left of the field's first column minus 1

Details

The _getCurcol method returns the position of the text cursor (relative to the text entry field) when a user either clicks with the mouse or presses the RETURN or ENTER key. The cursor can be in the master region or in another object. If the text cursor is in an area to the left of the field's first column, the number returned is less than or equal to zero; if the cursor is in an area to the right of the first column, the number returned is positive.

Examples

_getCurcol returns the cursor position relative to the first column of the field TEXT1. TEXT1 has a length of 6.

Assume the cursor is on the third character of TEXT1, as shown here:

                  X         cursor position
              _ _ _ _ _ _   TEXT1
-4 -3 -2 -1 0 1 2 3 4 5 6   column numbers

This statement returns a 3 in the SCL variable MYCOL:

 call notify ('text1','_get_curcol_',mycol);

Assume the cursor is 5 columns (in any row) to the left of the first column of TEXT1, as shown here:

 X                          cursor position
              _ _ _ _ _ _   TEXT1
-4 -3 -2 -1 0 1 2 3 4 5 6   column numbers

This statement returns a -4 in the SCL variable MYCOL:

 call notify ('text1','_get_curcol_',mycol);

Chapter Contents
Previous
Next
Top of Page