SetCursor (ScreenField subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
 
mNo edit summary
Line 1: Line 1:
This method positions the cursor at the beginning of the referenced ScreenField object. An optional numeric argument positions the cursor within the field.
This method positions the cursor at the beginning of the referenced ScreenField object. An optional numeric argument positions the cursor within the field.


  %sfield:SetCursor(position)
==Syntax==
===Syntax terms===
<dl>%sfield
<dd>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 [[Screen class#AddField function|AddField method]].
</dl>


; Itemid syntax
==Usage Notes==
 
; %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 [[Screen class#AddField function|AddField method]].
 
; Usage Notes


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


; Examples
==Examples==


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

Revision as of 20:29, 18 March 2011

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

Syntax

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='===>')