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}} | {{Template:Screen:CursorItemId syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th>%num</th> | ||
< | <td>A numeric variable to contain the returned item ID. If no item ID was assigned to the screenField, zero is returned. </td></tr> | ||
< | <tr><th>%screen</th> | ||
< | <td>A reference to an instance of a Screen object.</td></tr> | ||
</ | </table> | ||
==See also== | ==See also== | ||
{{Template:Screen:CursorItemId footer}} | {{Template:Screen:CursorItemId footer}} | ||
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 (&#x201C;AddField&#x201D; 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. |