CursorItemId (Screen function): Difference between revisions
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
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 ( | {{Template:Screen:CursorItemId subtitle}} | ||
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 | [%num =] %screen:cursorItemID | ||
| Line 10: | Line 12: | ||
; %screen | ; %screen | ||
: A reference to an instance of a Screen object. | : A reference to an instance of a Screen object. | ||
==See also== | |||
{{Template:Screen:CursorItemId footer}} | |||
Revision as of 16:58, 16 February 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.
[%num =] %screen:cursorItemID
- CursorItemID syntax
- %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.