CursorItemId (Screen function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (match syntax table to syntax template; edits, tags and links) |
||
| Line 1: | Line 1: | ||
{{Template:Screen:CursorItemId subtitle}} | {{Template:Screen:CursorItemId subtitle}} | ||
The <var>CursorItemId</var> callable function returns the numeric item ID of the <var>ScreenField</var> where the cursor is cuirrently located. A <var>ScreenField</var> is assigned an item ID either when it is instantiated by the <var>[[AddField_(Screen_function)|AddField]]</var> method, or if it is (re-)specified with the <var>[[Itemid_(ScreenField_property)|Itemid]]</var> method. | |||
==Syntax== | ==Syntax== | ||
| Line 8: | Line 7: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%num</th> | <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> | <td>A numeric variable to contain the returned item ID. If no item ID was assigned to the <var>screenField</var>, zero is returned. </td></tr> | ||
<tr><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> | ||
</table> | </table> | ||
==See also== | ==See also== | ||
{{Template:Screen:CursorItemId footer}} | {{Template:Screen:CursorItemId footer}} | ||
Revision as of 09:17, 25 June 2011
Return the item ID of field at the cursor position (Screen class)
The CursorItemId callable function returns the numeric item ID of the ScreenField where the cursor is cuirrently located. A ScreenField is assigned an item ID either when it is instantiated by the AddField method, or if it is (re-)specified with the 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. |