CursorItemId (Screen function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
Line 1: | Line 1: | ||
{{Template:Screen:CursorItemId subtitle}} | {{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]]. | 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]]. | ||
==Syntax== | ==Syntax== | ||
{{Template:Screen:CursorItemId syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<dl> | <dl> |
Revision as of 19:30, 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
[%number =] screen:CursorItemId
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