SetCursor (ScreenField subroutine)

Set or return the value of a screenfield (ScreenField class)

This method positions the cursor at the beginning of the referenced ScreenField object. An optional numeric argument positions the cursor within the field.

Syntax

sfield:SetCursor[( [position])]

Syntax terms

%sfield

A reference to an instance of a ScreenField object. position A positive integral value that specifies the relative position within the object screenfield %sfield, where position 1 is the first position in the field and where the maximum width is set by the AddField method.

Usage notes

If the position exceeds the maximum width of the field, the request is canceled.

Examples

The following sequence sets the cursor on an unprotected screenfield immediately to the right of a field with a protected “===>” command prompt:

...
%scr is object Screen
%prompt is object ScreenField
%cmd is object ScreenField
%prompt = %scr:addField(row=2, color=white, -
value='===>')

See also

Screen class ScreenField class	List of Screen methods List of ScreenField methods List of Screen API methods	Screen methods syntax ScreenField methods syntax
Notation conventions for methods