Item (NamedArraylist property): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:NamedArraylist:Item subtitle}} | |||
This ReadWrite property returns or sets the value of the item that has the | This ReadWrite property returns or sets the value of the item that has the | ||
| Line 12: | Line 7: | ||
see [[Collections#Coding considerations for collections|Coding considerations for collections]]. | see [[Collections#Coding considerations for collections|Coding considerations for collections]]. | ||
==Syntax== | ==Syntax== | ||
{{Template:NamedArraylist:Item syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
| Line 25: | Line 17: | ||
<td>A string that serves as a subscript to identify a ''%namrayl'' item.</td></tr> | <td>A string that serves as a subscript to identify a ''%namrayl'' item.</td></tr> | ||
</table> | </table> | ||
==Usage | ==Usage notes== | ||
<ul> | <ul> | ||
<li>If the Item property is being set and there is already an item | <li>If the Item property is being set and there is already an item | ||
| Line 53: | Line 45: | ||
lets you retrieve or set an item using its item number. | lets you retrieve or set an item using its item number. | ||
</ul> | </ul> | ||
==See also== | |||
{{Template:NamedArraylist:Item footer}} | |||
Revision as of 04:19, 7 February 2011
Value of named item (NamedArraylist class)
This ReadWrite property returns or sets the value of the item that has the
given name in the NamedArraylist.
For additional comments about the Item method in collections, see Coding considerations for collections.
Syntax
%currentItem = nal:Item( string) nal:Item( string) = newItem Throws ItemNotPresent
Syntax terms
| %item | A variable of the same type as specified on the %namrayl declaration to contain the value of the specified %namrayl item. Or a variable or value of the same type as specified on the %namrayl declaration to be assigned to the specified %namrayl item. |
|---|---|
| %namrayl | A NamedArraylist object. |
| name | A string that serves as a subscript to identify a %namrayl item. |
Usage notes
- If the Item property is being set and there is already an item
on the NamedArraylist that has the specified name, that item is replaced.
If the Item property is being set and there is no item on the NamedArraylist
that has the indicated name, the item is added.
If the Item property is being retrieved and there is no item on the NamedArraylist
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.
- The Item keyword is not required.
For example, in the request at the start of the
NamedArraylist class, %alist('Idle') = 'Eric', for instance,
is equivalent to:
%alist:Item('Idle') = 'Eric'
- As shown in the example at the start of the NamedArraylist class, NamedArraylist items are ordered alphabetically by their names. Accordingly, the Item method takes a name argument. The ItemByNumber method, described below, lets you retrieve or set an item using its item number.