CursorItemId (Screen function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 3: Line 3:
This callable function returns the numeric item ID of the ScreenField where the cursor is located. A ScreenField is assigned an item ID either when it is instantiated by the AddField method (“AddField” on page 894), or if it is specified with the [[Screenfield class#Itemid property|Screenfield Itemid method]].
This callable function returns the numeric item ID of the ScreenField where the cursor is located. A ScreenField is assigned an item ID either when it is instantiated by the AddField method (“AddField” on page 894), or if it is specified with the [[Screenfield class#Itemid property|Screenfield Itemid method]].


  [%num =] %screen:cursorItemID
==Syntax==
 
===Syntax terms===
; <font size='3'>CursorItemID syntax</font>
<dl>
 
<dt>%num  
; %num  
<dd>A numeric variable to contain the returned item ID. If no item ID was assigned to the screenField, zero is returned.
: A numeric variable to contain the returned item ID. If no item ID was assigned to the screenField, zero is returned.
<dt>%screen  
 
<dd>A reference to an instance of a Screen object.
; %screen  
: A reference to an instance of a Screen object.
==See also==
==See also==
{{Template:Screen:CursorItemId footer}}
{{Template:Screen:CursorItemId footer}}

Revision as of 19:29, 18 March 2011

Return the item ID of field at the cursor position (Screen class)


This callable function returns the numeric item ID of the ScreenField where the cursor is located. A ScreenField is assigned an item ID either when it is instantiated by the AddField method (“AddField” on page 894), or if it is specified with the Screenfield Itemid method.

Syntax

Syntax terms

%num
A numeric variable to contain the returned item ID. If no item ID was assigned to the screenField, zero is returned.
%screen
A reference to an instance of a Screen object.

See also