Item (FloatNamedArraylist property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 1: Line 1:
<span style="font-size:120%; color:black"><b><section begin=dpl_desc/>Value of item specified by subscript<section end=dpl_desc/></b></span>
{{Template:FloatNamedArraylist:Item subtitle}}
[[Category:FloatNamedArraylist methods|Item property]]
<!--DPL?? Category:FloatNamedArraylist methods|Item property: Value of item specified by subscript-->
<p>
Item is a member of the [[FloatNamedArraylist class]].
</p>


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==
<p class="code">%item = %fnamrayl:Item(subscript)
{{Template:FloatNamedArraylist:Item syntax}}
 
%fnamrayl:Item(subscript) = %item
</p>
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
Line 25: Line 17:
<td>A number that serves as a subscript to identify a ''%fnamrayl'' item.</td></tr>
<td>A number that serves as a subscript to identify a ''%fnamrayl'' item.</td></tr>
</table>
</table>
==Usage Notes==
==Usage notes==
<ul>
<ul>
<li>The <tt>Item</tt> keyword is not required.
<li>The <tt>Item</tt> keyword is not required.
Line 55: Line 47:
lets you retrieve or set an item using the item's subscript number.
lets you retrieve or set an item using the item's subscript number.
</ul>
</ul>
==See also==
{{Template:FloatNamedArraylist:Item footer}}

Revision as of 04:19, 7 February 2011

Value of named item (FloatNamedArraylist class)


This ReadWrite property 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

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

Usage notes

  • The Item keyword is not required. For example, in the request in the FloatNamedArraylist class example, %y(7) = 'seven', for instance, 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:
    • The request is cancelled if the UseDefault UseDefault property value is False.
    • The Default value is returned if the UseDefault property is True.
  • As shown in the example in the FloatNamedArraylist class article, FloatNamedArraylist items are ordered numerically by their subscript numbers. Accordingly, the Item method takes a numerical subscript argument. The ItemByNumber method, described below, lets you retrieve or set an item using the item's ordinal number. The NameByNumber property lets you retrieve or set an item using the item's subscript number.

See also