Item (UnicodeNamedArraylist property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 1: Line 1:
{{Template:UnicodeNamedArraylist:Item subtitle}}
{{Template:UnicodeNamedArraylist:Item subtitle}}
 
<var>Item</var> is a ReadWrite property returns or sets the value of the item that has the specified subscript name in the <var>UnicodeNamedArraylist</var>.
<var>Item</var> is a ReadWrite property returns or sets the value of the item that has the specified subscript name in the <var>UnicodeNamedArraylist</var>.
 
For additional comments about the Item 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:UnicodeNamedArraylist:Item syntax}}
{{Template:UnicodeNamedArraylist:Item syntax}}
Line 16: Line 16:
<td>A Unicode string that serves as a subscript to identify a <var class="term">uniNal</var> item.</td></tr>
<td>A Unicode string that serves as a subscript to identify a <var class="term">uniNal</var> item.</td></tr>
<tr><th>newItem</th>
<tr><th>newItem</th>
<td>A variable or value of the same type as specified on the <var class="term">uniNal</var> declaration to be assigned to the specified <var class="term">uniNal</var> item. </td></tr>
<td>A value of the same type as specified on the <var class="term">uniNal</var> declaration to be assigned to the specified <var class="term">uniNal</var> item. </td></tr>
</table>
</table>
 
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>The <code>Item</code> keyword is not required.  For example, in the request in the <var>[[UnicodeNamedArraylist class|UnicodeNamedArraylist]]</var> class example, the following statement:
<li>The <var>Item</var> keyword is not required.  For example, in the first [[UnicodeNamedArraylist class#Example|"Example"]] on the <var>UnicodeNamedArraylist</var> class page, the following statement:
<p class="code">%k('&amp;sect;Apr':u) = 'Leo'</p>
<p class="code">%k('&amp;sect;Apr':u) = 'Leo'</p>
is equivalent to:
is equivalent to:
Line 31: Line 31:
<li>If the <var>[[UseDefault (UnicodeNamedArraylist property)|UseDefault]]</var> property value is <code>False</code>:
<li>If the <var>[[UseDefault (UnicodeNamedArraylist property)|UseDefault]]</var> property value is <code>False</code>:
<ul>
<ul>
<li>Under <var>Sirius Mods</var> version 8.0 and later an [[ItemNotPresent class|ItemNotPresent exception]] is thrown.
<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.
<li>Under <var>Sirius Mods</var> version 7.9 and earlier the request is cancelled.
</ul>
</ul>
Line 43: Line 43:
<li>As shown in the example in the [[UnicodeNamedArraylist class]] article, <var>UnicodeNamedArraylist</var> items are ordered alphabetically by their subscript names.  Accordingly, the <var>Item</var> method takes a Unicode string as its argument.
<li>As shown in the example in the [[UnicodeNamedArraylist class]] article, <var>UnicodeNamedArraylist</var> items are ordered alphabetically by their subscript names.  Accordingly, the <var>Item</var> method takes a Unicode string as its argument.
</ul>
</ul>
 
==See also==
==See also==
<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.

Revision as of 20:14, 3 August 2012

Value of named item (UnicodeNamedArraylist class)


Item is a ReadWrite property returns or sets the value of the item that has the specified subscript name in the UnicodeNamedArraylist.

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

Syntax

%currentItem = uniNal:Item( unicode) uniNal:Item( unicode) = newItem Throws ItemNotPresent

Syntax terms

%currentItem A variable of the same type as specified on the uniNal declaration to contain the value of the specified uniNal item.
uniNal A UnicodeNamedArraylist object.
unicode A Unicode string that serves as a subscript to identify a uniNal item.
newItem A value of the same type as specified on the uniNal declaration to be assigned to the specified uniNal item.

Usage notes

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

    %k('&sect;Apr':u) = 'Leo'

    is equivalent to:

    %k:Item('&sect;Apr':u) = 'Leo'

  • If the Item property is being set and there is already an item on the UnicodeNamedArraylist that has the specified name, that item is replaced. If the Item property is being set and there is no item on the UnicodeNamedArraylist that has the indicated name, the item is added.
  • If the Item property is being retrieved and there is no item on the UnicodeNamedArraylist that has the indicated name, 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 example in the UnicodeNamedArraylist class article, UnicodeNamedArraylist items are ordered alphabetically by their subscript names. Accordingly, the Item method takes a Unicode string as its argument.

See also

  • The ItemByNumber property lets you retrieve or set an item using the item's ordinal number.
  • The NameByNumber function lets you retrieve an item's name using the item's ordinal number.
  • The Number function lets you retrieve an item's ordinal number using the item's name.