ItemByNumber (GenericNamedArraylist property): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (It's not just a namedarraylist anymore Toto) |
||
| Line 1: | Line 1: | ||
{{Template:GenericNamedArraylist:ItemByNumber subtitle}} | {{Template:GenericNamedArraylist:ItemByNumber subtitle}} | ||
<var>ItemByNumber</var> is a ReadWrite property returns or sets the <var>[[FloatNamedArraylist class|FloatNamedArraylist]]</var>, <var>[[NamedArraylist class|NamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class|UnicodeNamedArraylist]]</var>item that has the specified 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 alphabetically 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> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>If the ItemByNumber property is being set and there is already an item | <li>If the <var>ItemByNumber</var> property is being set and there is already an item on the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> that has the specified number, that item is replaced. If the <var>ItemByNumber</var> property is being set and there is no item on the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> that has the indicated number, the item is added. If the <var>ItemByNumber</var> property is being retrieved and there is no item on the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> that has the indicated number, the result is one of the following actions: | ||
on the NamedArraylist that has the specified number, that item is replaced. | |||
If the ItemByNumber property is being set and there is no item on the | |||
NamedArraylist that has the indicated number, the item is added. | |||
If the ItemByNumber property is being retrieved and there is no item on the | |||
NamedArraylist that has the indicated number, | |||
the result is one of the following actions: | |||
<ul> | <ul> | ||
<li>The request is cancelled if the | <li>The request is cancelled if the <var>[[UseDefault (NamedArraylist property)|UseDefault]]</var> property value is <code>False</code>. | ||
[[UseDefault (NamedArraylist property)|UseDefault]] property value is < | <li>The <var>[[Default (NamedArraylist property)|Default]]</var> value is returned if the <var>UseDefault</var> property is <code>True</code>. | ||
<li>The [[Default (NamedArraylist property)|Default]] value is returned if the | |||
UseDefault property is < | |||
</ul> | </ul> | ||
</ul> | </ul> | ||
==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, lets you retrieve or set an item using its item key.</ul> | |||
{{Template:GenericNamedArraylist:ItemByNumber footer}} | {{Template:GenericNamedArraylist:ItemByNumber footer}} | ||
Revision as of 09:31, 4 March 2011
Return or set item using item number (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)
ItemByNumber is a ReadWrite property returns or sets the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylistitem that has the specified 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 alphabetically 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. |
Usage notes
- If the ItemByNumber property is being set and there is already an item on the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist that has the specified number, that item is replaced. If the ItemByNumber property is being set and there is no item on the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist that has the indicated number, the item is added. If the ItemByNumber property is being retrieved and there is no item on the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist that has the indicated number, the result is one of the following actions:
- The request is cancelled if the UseDefault property value is
False. - The Default value is returned if the UseDefault property is
True.
- The request is cancelled if the UseDefault property value is
See also
- The Item properties for FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist respectively, lets you retrieve or set an item using its item key.