CursorColumn (Screen property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax table to syntax template; edits, tags and links)
Line 1: Line 1:
{{Template:Screen:CursorColumn subtitle}}
{{Template:Screen:CursorColumn subtitle}}
The <var>CursorColumn</var> property either gets the column number where the cursor is currently positioned, or it sets the column number for the cursor position.


This property either gets the column number where the cursor is currently positioned, or it sets the column number for the cursor position.
==Syntax==
==Syntax==
{{Template:Screen:CursorColumn syntax}}
{{Template:Screen:CursorColumn syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%num</th>
<tr><th>%currentNum</th>
<td>A numeric variable or expression for the column number. </td></tr>
<td>A numeric variable to receive the current cursor column number.</td></tr>
<tr><th>%screen</th>
<tr><th>screen</th>
<td>A reference to an instance of a Screen object.</td></tr>
<td>A reference to an instance of a <var>Screen</var> object.</td></tr>
<tr><th>newNum</th>
<td>A numeric variable or expression setting the new column that the cursor will be positioned at.</td></tr>
</table>
</table>


==Usage notes==
==Usage notes==
 
<ul><li>Although you can set an absolute position for the cursor using <var>CursorColumn</var> and <var>[[CursorRow (Screen property)|CursorRow]]</var>, it is generally more useful to use the <var>[[SetCursor (ScreenField subroutine)|SetCursor]]</var> subroutine to move the cursor to a particular field, independent of its absolute location on the screen.
Although you can set an absolute position for the cursor using <var>CursorColumn</var> and <var>[[CursorRow (Screen property)|CursorRow]]</var>, it is generally more useful to use the <var>ScreenField</var> <var>[[SetCursor (ScreenField subroutine)|SetCursor]]</var> subroutine to move the cursor to a particular field, independent of its absolute location on the screen.
</ul>


==See also==
==See also==
{{Template:Screen:CursorColumn footer}}
{{Template:Screen:CursorColumn footer}}

Revision as of 09:12, 25 June 2011

Return the column number of the cursor position (Screen class)

The CursorColumn property either gets the column number where the cursor is currently positioned, or it sets the column number for the cursor position.

Syntax

%currentNumber = screen:CursorColumn screen:CursorColumn = newNumber

Syntax terms

%currentNum A numeric variable to receive the current cursor column number.
screen A reference to an instance of a Screen object.
newNum A numeric variable or expression setting the new column that the cursor will be positioned at.

Usage notes

  • Although you can set an absolute position for the cursor using CursorColumn and CursorRow, it is generally more useful to use the SetCursor subroutine to move the cursor to a particular field, independent of its absolute location on the screen.

See also