Itemid (ScreenField property) - Revision history

JAL at 19:41, 20 November 2012

2012-11-20T19:41:14Z

← Older revision		Revision as of 19:41, 20 November 2012
Line 4:		Line 4:
	==Syntax==		==Syntax==
	{{Template:ScreenField:Itemid syntax}}		{{Template:ScreenField:Itemid syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~currentNum~~</th>		<tr><th>%currentNumber</th>
	<td>An integral numeric variable or expression, to get the current item id value.</td></tr>		<td>An integral numeric variable or expression, to get the current item id value.</td></tr>

	<tr><th>sfield</th>		<tr><th>sfield</th>
	<td>A reference to an instance of a <var>ScreenField</var> object.</td></tr>		<td>A reference to an instance of a <var>ScreenField</var> object.</td></tr>
	<tr><th>~~newNum~~</th>
			<tr><th>newNumber</th>
	<td>An integral numeric variable or expression, which can range from 1 to 32767, to set the new item id value.</td></tr>		<td>An integral numeric variable or expression, which can range from 1 to 32767, to set the new item id value.</td></tr>
	</table>		</table>

JAL at 19:34, 20 November 2012

2012-11-20T19:34:42Z

← Older revision		Revision as of 19:34, 20 November 2012
Line 1:		Line 1:
	{{Template:ScreenField:Itemid subtitle}}		{{Template:ScreenField:Itemid subtitle}}
	The <var>Itemid</var> property sets or returns a numeric item ID value for a <var>ScreenField</var>. This ID is initially set for a field by the <var>[[~~Screen class#AddField function~~\|AddField]]</var> method..		The <var>Itemid</var> property sets or returns a numeric item ID value for a <var>ScreenField</var>. This ID is initially set for a field by the <var>[[AddField_(Screen_function)\|AddField]]</var> method.

	==Syntax==		==Syntax==

Goff: match syntax table to syntax template; edits, tags and links

2011-07-01T04:05:15Z

match syntax table to syntax template; edits, tags and links

← Older revision		Revision as of 04:05, 1 July 2011
Line 1:		Line 1:
	{{Template:ScreenField:Itemid subtitle}}		{{Template:ScreenField:Itemid subtitle}}
			The <var>Itemid</var> property sets or returns a numeric item ID value for a <var>ScreenField</var>. This ID is initially set for a field by the <var>[[Screen class#AddField function\|AddField]]</var> method..

	~~This property sets or returns a numeric item ID value for a ScreenField. This ID is initially set for a field by the [[Screen class#AddField function\|AddField method]].~~
	==Syntax==		==Syntax==
	{{Template:ScreenField:Itemid syntax}}		{{Template:ScreenField:Itemid syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>~~num~~</th>		<tr><th>%currentNum</th>
	<td>An integral numeric variable or expression, ~~which can range from 1~~ to ~~32767~~. </td></tr>		<td>An integral numeric variable or expression, to get the current item id value.</td></tr>
	<tr><th>%sfield</th>		<tr><th>sfield</th>
	<td>A reference to an instance of a ScreenField object.</td></tr>		<td>A reference to an instance of a <var>ScreenField</var> object.</td></tr>
			<tr><th>newNum</th>
			<td>An integral numeric variable or expression, which can range from 1 to 32767, to set the new item id value.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
			<ul><li>Any <var>screenfield</var> can be assigned an item ID.
			<li>An item ID is very practical when using <var>[[Arraylist_class\|arraylists]]</var> of <var>screenfields</var>. <var>ScreenField</var> objects within an <var>arraylist</var> can be assigned item IDs corresponding to the element numbers of the <var>arraylist</var>. For example, the <var>[[Screen class#CursorItemId\|CursorItemId]]</var> method will return the item ID of the <var>screenField</var> object where the cursor is positioned. The item ID can then be used as the element number to reference a <var>ScreenField</var> object within an arraylist.
			<li>Any <var>screenField</var> not assigned an item ID value will return zero. No check is made to ensure any item Id is unique. This is the programmer's responsibility.
			</ul>

	~~Any screenfield can be assigned an item ID.~~

	An item ID is very practical when using arraylists of screenfields. ScreenField objects within an arraylist can be assigned item IDs corresponding to the element numbers of the arraylist. For example, the [[Screen class#CursorItemId\|Screen method CursorItemId]] will return the item ID of the screenField object where the cursor is positioned. The item ID can then be used as the element number to reference a ScreenField object within an arraylist.

	~~Any screenField not assigned an item ID value will return zero. No check is made to ensure any item Id is unique. This is the programmer's responsibility.~~
	==See also==		==See also==
	{{Template:ScreenField:Itemid footer}}		{{Template:ScreenField:Itemid footer}}

TomWiccan: 1 revision

2011-03-18T20:21:26Z

1 revision

← Older revision		Revision as of 20:21, 18 March 2011
Line 5:		Line 5:
	{{Template:ScreenField:Itemid syntax}}		{{Template:ScreenField:Itemid syntax}}
	===Syntax terms===		===Syntax terms===
	<dl>		<table class="syntaxTable">
	<dt>num		<tr><th>num</th>
	<dd>An integral numeric variable or expression, which can range from 1 to 32767.		<td>An integral numeric variable or expression, which can range from 1 to 32767. </td></tr>
	<dt>%sfield		<tr><th>%sfield</th>
	<dd>A reference to an instance of a ScreenField object.		<td>A reference to an instance of a ScreenField object.</td></tr>
	</dl>		</table>

	==Usage notes==		==Usage notes==

TomWiccan: 1 revision

2011-03-18T20:21:20Z

1 revision

← Older revision	Revision as of 20:21, 18 March 2011
(No difference)

Tom at 20:21, 18 March 2011

2011-03-18T20:21:20Z

← Older revision		Revision as of 20:21, 18 March 2011
Line 1:		Line 1:
			{{Template:ScreenField:Itemid subtitle}}

	This property sets or returns a numeric item ID value for a ScreenField. This ID is initially set for a field by the [[Screen class#AddField function\|AddField method]].		This property sets or returns a numeric item ID value for a ScreenField. This ID is initially set for a field by the [[Screen class#AddField function\|AddField method]].
	==Syntax==		==Syntax==
			{{Template:ScreenField:Itemid syntax}}
	===Syntax terms===		===Syntax terms===
	<dl>		<dl>
Line 9:		Line 12:
	</dl>		</dl>

	==Usage ~~Notes~~==		==Usage notes==

	Any screenfield can be assigned an item ID.		Any screenfield can be assigned an item ID.
Line 16:		Line 19:

	Any screenField not assigned an item ID value will return zero. No check is made to ensure any item Id is unique. This is the programmer's responsibility.		Any screenField not assigned an item ID value will return zero. No check is made to ensure any item Id is unique. This is the programmer's responsibility.
			==See also==
			{{Template:ScreenField:Itemid footer}}

Tom at 20:21, 18 March 2011

2011-03-18T20:21:11Z

@@ Line 1: / Line 1: @@
 This property sets or returns a numeric item ID value for a ScreenField. This ID is initially set for a field by the [[Screen class#AddField function|AddField method]].
-   %sfield:Itemid = num
+==Usage Notes==
 Any screenfield can be assigned an item ID.

Tom: /* Itemid property */

2011-01-28T19:43:31Z

Itemid property

New page

This property sets or returns a numeric item ID value for a ScreenField. This ID is initially set for a field by the [[Screen class#AddField function|AddField method]].

%sfield:Itemid = num
num = %sfield:Itemid

; Itemid syntax

; num
: An integral numeric variable or expression, which can range from 1 to 32767.

: %sfield
: A reference to an instance of a ScreenField object.

; Usage Notes

Any screenfield can be assigned an item ID.

An item ID is very practical when using arraylists of screenfields. ScreenField objects within an arraylist can be assigned item IDs corresponding to the element numbers of the arraylist. For example, the [[Screen class#CursorItemId|Screen method CursorItemId]] will return the item ID of the screenField object where the cursor is positioned. The item ID can then be used as the element number to reference a ScreenField object within an arraylist.

Any screenField not assigned an item ID value will return zero. No check is made to ensure any item Id is unique. This is the programmer's responsibility.