Cursor (Property)

The mouse cursor is used to easily view the location where the action will be performed. For a control in edit, the cursor turns into a blinking vertical line, allowing you to easily identify the location of the next character typed.

If a selection is performed in the control, the selected characters are displayed in "reverse video". The position of the cursor corresponds to the beginning of the area displayed in "reverse video".

Some examples:


	The input cursor is located at the beginning of the input area. Its position is 1.
	The input cursor is located at the end of the input area. Its position is 7 in this example.
	The input cursor is located at the beginning of the area in "reverse video" (position 3 in this example). ..CursorEnd is used to find out and modify the end of the selected area.

Versions 19 and later

This property is now available in Windows Store Apps mode.

New in version 19

This property is now available in Windows Store Apps mode.

Versions 20 and later

This property is now available for the table columns in the Android applications.

New in version 20

This property is now available for the table columns in the Android applications.

Versions 21 and later

This property is now available in Universal Windows 10 App mode.

This function is now available for iPhone/iPad applications.

New in version 21

This property is now available in Universal Windows 10 App mode.

This function is now available for iPhone/iPad applications.

This property is now available in Universal Windows 10 App mode.

This function is now available for iPhone/iPad applications.

..Cursor is used to find out and modify the position of the mouse cursor in one fo the following controls:

Edit control.
Editable Combo Box control.
"Edit control" column and "Editable Combo Box" column in a Table control.
Versions 22 and later
Word Processing control.
New in version 22
Word Processing control.
Word Processing control.

Remark: To find out the text selected in an edit control, an editable Combo Box or a column in a Table control, you can use ..SelectedText.

Versions 15 and later

This property is now available for the Android applications on the edit controls.

New in version 15

This property is now available for the Android applications on the edit controls.

Versions 20 and later

This property is now available for Android applications on the columns of the Table controls.

New in version 20

This property is now available for Android applications on the columns of the Table controls.

Tip: To select a text section in an edit control from a Button control:

The option "Automatic erase" must not be enabled in the edit control (unless the entire content of the control must be deleted).
The button must be an "Interruption" button and it must contain the following code for example:

// -- Click of BTN_Selection (Interrupt button)
// Select the entire text
EDT_Edit1..Cursor = 1
EDT_Edit1..CursorEnd = Length(EDT_Edit1) + 1
ScreenFirst(EDT_Edit1)

Example

See additional examples

// Insert a character string at cursor position
EDT_ControlName = Left(EDT_ControlName, EDT_ControlName..Cursor) + ...
" is called " + Right(EDT_ControlName, EDT_ControlName..Cursor)

Syntax

Finding out the position of the input cursor Hide the details

<Current value> = <Control used>..Cursor

<Current value>: Integer

Current position of the input cursor in the control. This position can vary between:
0 (the control is not in edit and there is no input cursor).
The number of characters displayed in the control + 1 (the input cursor is located at the end of the input area).

<Control used>: Control name

Name of the control in which the input cursor is displayed:
Edit control.
Editable Combo Box control.
"Edit control" column and "Editable Combo Box" column in a Table control.
Versions 22 and later
Word Processing control.
New in version 22
Word Processing control.
Word Processing control.

Modifying the position of the input cursor Hide the details

<Control used>..Cursor = <New value>

<Control used>: Control name

Name of the control where the position of the input cursor must be modified:
Edit control.
Editable Combo Box control.
"Edit control" column and "Editable Combo Box" column in a Table control.
Versions 22 and later
Word Processing control.
New in version 22
Word Processing control.
Word Processing control.

<New value>: Integer

New position of the input cursor, between 1 and the number of characters currently displayed in the control + 1.

Remarks

Special case: RTF control

The number of characters displayed in an RTF control can differ if this control contains CR characters (Carriage Return).

Indeed, the CR character corresponds to two characters in a non-RTF control while it corresponds to one character in an RTF control.

Limit: Modifying the position of the input cursor

The position of the input cursor can be modified only if the control is currently in edit. If the control is not currently in edit, ..Cursor returns 0.

Reminder: To force the input in a control, use ScreenFirst or ReturnToCapture.