ItemByNumber (GenericNamedArraylist property): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:GenericNamedArraylist:ItemByNumber subtitle}} | {{Template:GenericNamedArraylist:ItemByNumber subtitle}} | ||
<var>ItemByNumber</var> is a ReadWrite property that returns or sets the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> item that has the specified ordinal item number. | |||
the specified item number. | |||
==Syntax== | ==Syntax== | ||
{{Template:GenericNamedArraylist:ItemByNumber syntax}} | {{Template:GenericNamedArraylist:ItemByNumber syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%currentItem</th> | ||
<td>A variable of the same type as specified on the | <td>A variable of the same type as specified on the <var class="term">anyNal</var> declaration to contain the value of the specified <var class="term">anyNal</var> item.</td></tr> | ||
<tr><th> | <tr><th>anyNal</th> | ||
<td>A NamedArraylist object. </td></tr> | <td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object. </td></tr> | ||
<tr><th>number</th> | <tr><th>number</th> | ||
<td>A whole number greater than 0 to identify a | <td>A whole number greater than 0 to identify a <var class="term">anyNal</var> item by its position in the ordered <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var>. If <var class="term">number</var> is greater than the number of items in <var class="term">anyNal</var>, or if it is less than or equal to zero, the request is cancelled.</td></tr> | ||
<tr><th>newItem</th> | |||
<td>A variable or value of the same type as specified on the <var class="term">anyNal</var> declaration to be assigned to the specified <var class="term">anyNal</var> item. </td></tr> | |||
</table> | </table> | ||
==See also== | ==See also== | ||
<ul><li>The <var>Item</var> properties for <var>[[Item_(FloatNamedArraylist_property)|FloatNamedArraylist]]</var>, <var>[[Item (NamedArraylist property)|NamedArraylist]]</var>, and <var>[[Item_(UnicodeNamedArraylist_property)|UnicodeNamedArraylist]]</var> respectively, let you retrieve or set an item using its item key.</ul> | |||
{{Template:GenericNamedArraylist:ItemByNumber footer}} | {{Template:GenericNamedArraylist:ItemByNumber footer}} | ||
Latest revision as of 03:18, 8 August 2012
Return or set item using item number (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)
ItemByNumber is a ReadWrite property that returns or sets the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist item that has the specified ordinal item number.
Syntax
%currentItem = anyNal:ItemByNumber( number) anyNal:ItemByNumber( number) = newItem
Syntax terms
| %currentItem | A variable of the same type as specified on the anyNal declaration to contain the value of the specified anyNal item. |
|---|---|
| anyNal | A FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist object. |
| number | A whole number greater than 0 to identify a anyNal item by its position in the ordered FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist. If number is greater than the number of items in anyNal, or if it is less than or equal to zero, the request is cancelled. |
| newItem | A variable or value of the same type as specified on the anyNal declaration to be assigned to the specified anyNal item. |
See also
- The Item properties for FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist respectively, let you retrieve or set an item using its item key.