Item (FloatNamedArraylist property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:FloatNamedArraylist:Item subtitle}}
{{Template:FloatNamedArraylist:Item subtitle}}
 
<var>Item</var> is a ReadWrite property returns or sets the value of the item that has the specified subscript number in the <var>FloatNamedArraylist</var>.
<!-- This is very close to the same method's page for these classes:
 
      NamedArraylist
      UnicodeNamedArraylist
    Many changes should be reflected to all three method's pages -->
<var>Item</var> is a ReadWrite property which returns or sets the value of the item that has the specified subscript number in the <var>FloatNamedArraylist</var>.
For additional comments about the <var>Item</var> method in collections, see [[Collections#Coding considerations for collections|"Coding considerations for collections"]].
For additional comments about the <var>Item</var> method in collections, see [[Collections#Coding considerations for collections|"Coding considerations for collections"]].
 
==Syntax==
==Syntax==
{{Template:FloatNamedArraylist:Item syntax}}
{{Template:FloatNamedArraylist:Item syntax}}
===Syntax terms===
===Syntax terms===
<!-- This is very close to the same method's page for these classes:
      NamedArraylist
      UnicodeNamedArraylist
    Many changes should be reflected to all three method's pages -->
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%currentItem</th>
<tr><th>%currentItem</th>
<td>A variable of the same type as specified on the <var class="term">fltNal</var> declaration to contain the value of the specified <var class="term">fltNal</var> item. Or a variable or value of the same type as specified on the <var class="term">fltNal</var> declaration to be assigned to the specified <var class="term">fltNal</var> item. </td></tr>
<td>A variable of the same type as specified on the <var class="term">fltNal</var> declaration to contain the value of the specified <var class="term">fltNal</var> item.</td></tr>
<tr><th>fltNal</th>
<tr><th>fltNal</th>
<td>A <var>FloatNamedArraylist</var> object. </td></tr>
<td>A <var>FloatNamedArraylist</var> object. </td></tr>
<tr><th>number</th>
<tr><th>number</th>
<td>A number that serves as a subscript to identify a <var class="term">fltNal</var> item.</td></tr>
<td>A number that serves as a subscript to identify a <var class="term">fltNal</var> item.</td></tr>
<tr><th>newItem</th>
<td>A value of the same type as specified on the <var class="term">fltNal</var> declaration to be assigned to the specified <var class="term">fltNal</var> item. </td></tr>
</table>
</table>
 
==Usage notes==
==Usage notes==
<!-- This is very close to the same method's page for these classes:
      NamedArraylist
      UnicodeNamedArraylist
    Many changes should be reflected to all three method's pages -->
<ul>
<ul>
<li>The <var>Item</var> keyword is not required.  For example, in the request in the [[FloatNamedArraylist class]] example, <code>%y(7) = 'seven'</code>, for instance, is equivalent to:
<li>The <var>Item</var> keyword is not required.  For example, in the first of the [[FloatNamedArraylist class#Examples|"Examples"]] on the <var>FloatNamedArraylist</var> class page, the following statement:
<p class="code">%y(7) = 'seven'</p>
is equivalent to:
<p class="code">%y:item(7) = 'seven'
<p class="code">%y:item(7) = 'seven'
</p>
</p>
<li>If the <var>Item</var> property is being set and there is already an item on the <var>FloatNamedArraylist</var> that has the specified subscript, that item is replaced.  If the <var>Item</var> property is being set and there is no item on the <var>FloatNamedArraylist</var> that has the indicated subscript, the item is added. If the <var>Item</var> property is being retrieved and there is no item on the <var>FloatNamedArraylist</var> that has the indicated subscript, the result is one of the following actions:
<li>If the <var>Item</var> property is being set and there is already an item on the <var>FloatNamedArraylist</var> that has the specified subscript, that item is replaced.  If the <var>Item</var> property is being set and there is no item on the <var>FloatNamedArraylist</var> that has the indicated subscript, the item is added.
<li>If the <var>Item</var> property is being retrieved and there is no item on the <var>FloatNamedArraylist</var> that has the indicated subscript, the result is one of the following actions:
<ul>
<ul>
<li>The request is cancelled if the <var>[[UseDefault (FloatNamedArraylist property)|UseDefault]]</var> property value is <code>False</code>.
<li>If the <var>[[UseDefault (FloatNamedArraylist property)|UseDefault]]</var> property value is <code>False</code>:
<ul>
<li>Under <var>Sirius Mods</var> version 8.0 and later an <var>[[ItemNotPresent class|ItemNotPresent exception]]</var> is thrown.
<li>Under <var>Sirius Mods</var> version 7.9 and earlier the request is cancelled.
</ul>
<li>The <var>[[Default (FloatNamedArraylist property)|Default]]</var> value is returned if the <var>UseDefault</var> property is <code>True</code>.
<li>The <var>[[Default (FloatNamedArraylist property)|Default]]</var> value is returned if the <var>UseDefault</var> property is <code>True</code>.
</ul>
</ul>
Regardless of the value of <var>UseDefault</var>, the presence of the item with the indicated name can be checked using the <var>[[Number (FloatNamedArraylist function)|Number]]</var> function, for example:
Regardless of the value of <var>UseDefault</var>, the presence of the item with the indicated name can be checked using the <var>[[Number (FloatNamedArraylist function)|Number]]</var> function, for example:
<p class="code">%num = %myLis:number(%key)
<p class="code">%num = %myLis:number(%key)
if %num then %name = %myLis:[[ItemByNumber (UnicodeNamedArraylist property)|itemByNumber]](%num)
if %num then %name = %myLis:[[ItemByNumber (FloatNamedArraylist property)|itemByNumber]](%num)
...
...
</p>
</p>
<li>As shown in the example in the [[FloatNamedArraylist class]] article, <var>FloatNamedArraylist</var> items are ordered numerically by their subscript numbers. Accordingly, the <var>Item</var> method takes a numerical <i>subscript</i> argument. 
<li>As shown in the first of the [[FloatNamedArraylist class#Examples|"Examples"]] on the <var>FloatNamedArraylist</var> class page,
<var>FloatNamedArraylist</var> items are ordered numerically by their subscript numbers.
</ul>
</ul>
 
==See also==
==See also==
<!-- This is very close to the same method's page for these classes:
      NamedArraylist
      UnicodeNamedArraylist
    Many changes should be reflected to all three method's pages -->
<ul><li>The <var>[[ItemByNumber_(GenericNamedArraylist_property)|ItemByNumber]]</var> property lets you retrieve or set an item using the item's ordinal number.
<ul><li>The <var>[[ItemByNumber_(GenericNamedArraylist_property)|ItemByNumber]]</var> property lets you retrieve or set an item using the item's ordinal number.
<li>The <var>[[NameByNumber (FloatNamedArraylist function)|NameByNumber]]</var> function lets you retrieve the "name" (numerical subscript) of the item that has the specified item number (position) .
<li>The <var>[[NameByNumber (FloatNamedArraylist function)|NameByNumber]]</var> function lets you retrieve the "name" (numerical subscript) of the item that has the specified item number (position) .
<li>The <var>[[Number (FloatNamedArraylist function)|Number]]</var> function lets you retrieve an item's ordinal number using the item's subscript number; it can be useful for determining whether an item exists for a specified subscript number.
</ul>
</ul>
 
{{Template:FloatNamedArraylist:Item footer}}
{{Template:FloatNamedArraylist:Item footer}}

Latest revision as of 16:42, 5 August 2012

Value of named item (FloatNamedArraylist class)


Item is a ReadWrite property which returns or sets the value of the item that has the specified subscript number in the FloatNamedArraylist.

For additional comments about the Item method in collections, see "Coding considerations for collections".

Syntax

%currentItem = fltNal:Item( number) fltNal:Item( number) = newItem Throws ItemNotPresent

Syntax terms

%currentItem A variable of the same type as specified on the fltNal declaration to contain the value of the specified fltNal item.
fltNal A FloatNamedArraylist object.
number A number that serves as a subscript to identify a fltNal item.
newItem A value of the same type as specified on the fltNal declaration to be assigned to the specified fltNal item.

Usage notes

  • The Item keyword is not required. For example, in the first of the "Examples" on the FloatNamedArraylist class page, the following statement:

    %y(7) = 'seven'

    is equivalent to:

    %y:item(7) = 'seven'

  • If the Item property is being set and there is already an item on the FloatNamedArraylist that has the specified subscript, that item is replaced. If the Item property is being set and there is no item on the FloatNamedArraylist that has the indicated subscript, the item is added.
  • If the Item property is being retrieved and there is no item on the FloatNamedArraylist that has the indicated subscript, the result is one of the following actions:
    • If the UseDefault property value is False:
      • Under Sirius Mods version 8.0 and later an ItemNotPresent exception is thrown.
      • Under Sirius Mods version 7.9 and earlier the request is cancelled.
    • The Default value is returned if the UseDefault property is True.

    Regardless of the value of UseDefault, the presence of the item with the indicated name can be checked using the Number function, for example:

    %num = %myLis:number(%key) if %num then %name = %myLis:itemByNumber(%num) ...

  • As shown in the first of the "Examples" on the FloatNamedArraylist class page, FloatNamedArraylist items are ordered numerically by their subscript numbers.

See also

  • The ItemByNumber property lets you retrieve or set an item using the item's ordinal number.
  • The NameByNumber function lets you retrieve the "name" (numerical subscript) of the item that has the specified item number (position) .
  • The Number function lets you retrieve an item's ordinal number using the item's subscript number; it can be useful for determining whether an item exists for a specified subscript number.