Item (UnicodeNamedArraylist property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 9: Line 9:
{{Template:UnicodeNamedArraylist:Item syntax}}
{{Template:UnicodeNamedArraylist:Item syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>%item</i>
<tr><th><i>%item</i></th>
<dd>A variable of the same
<td>A variable of the same type as specified on the ''%unamrayl'' declaration to contain the value of the specified ''%unamrayl'' item. Or a variable or value of the same type as specified on the ''%unamrayl'' declaration to be assigned to the specified ''%unamrayl'' item. </td></tr>
type as specified on the ''%unamrayl'' declaration
<tr><th><i>%unamrayl</i></th>
to contain the value of the specified ''%unamrayl'' item.
<td>A UnicodeNamedArraylist object. </td></tr>
Or a variable or value of the same
<tr><th><i>name</i></th>
type as specified on the ''%unamrayl'' declaration
<td>A Unicode string that serves as a subscript to identify a ''%unamrayl'' item.</td></tr>
to be assigned to the specified ''%unamrayl'' item.
</table>
<dt><i>%unamrayl</i>
<dd>A UnicodeNamedArraylist object.
<dt><i>name</i>
<dd>A Unicode string that serves as a subscript to identify
a ''%unamrayl'' item.
 
</dl>
==Usage notes==
==Usage notes==
<ul>
<ul>

Revision as of 23:09, 31 January 2011

Value of named item (UnicodeNamedArraylist class)


This 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

%item A variable of the same type as specified on the %unamrayl declaration to contain the value of the specified %unamrayl item. Or a variable or value of the same type as specified on the %unamrayl declaration to be assigned to the specified %unamrayl item.
%unamrayl A UnicodeNamedArraylist object.
name A Unicode string that serves as a subscript to identify a %unamrayl item.

Usage notes

  • The Item keyword is not required. For example, in the request in the UnicodeNamedArraylist class example, %k('&sect;Apr':u) = 'Leo', for instance, 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:
    • The request is cancelled if the UseDefault property value is False.
    • The Default value is returned if the UseDefault property is True.
  • 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 name argument. The ItemByNumber method, described below, lets you retrieve or set an item using the item's ordinal number. The NameByNumber function lets you retrieve or set an item using the item's subscript name.

See also