ItemByNumber (GenericNamedArraylist property): Difference between revisions

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


This ReadWrite property returns or sets the NamedArraylist item that has
This ReadWrite property returns or sets the NamedArraylist item that has
the specified item number.
the specified item number.
==Syntax==
==Syntax==
  %item = %namrayl:ItemByNumber(number)
{{Template:GenericNamedArraylist:ItemByNumber syntax}}
 
===Syntax terms===
  %namrayl:ItemByNumber(number) = %item
===Syntax Terms===
<dl>
<dl>
<dt><i>%item</i>
<dt><i>%item</i>
Line 31: Line 24:


</dl>
</dl>
==Usage Notes==
==Usage notes==
<ul>
<ul>
<li>If the ItemByNumber property is being set and there is already an item
<li>If the ItemByNumber property is being set and there is already an item
Line 51: Line 44:
set an item using its item name.
set an item using its item name.
</ul>
</ul>
==See also==
{{Template:GenericNamedArraylist:ItemByNumber footer}}

Revision as of 20:53, 28 January 2011

Return or set item using item number (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)


This ReadWrite property returns or sets the NamedArraylist item that has the specified item number.

Syntax

%currentItem = anyNal:ItemByNumber( number) anyNal:ItemByNumber( number) = newItem

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.
number
A whole number greater than 0 to identify a %namrayl item by its position in the alphabetically ordered NamedArraylist. If number is greater than the number of items in %namrayl, or if it is less than or equal to zero, the request is cancelled.

Usage notes

  • If the ItemByNumber property is being set and there is already an item on the NamedArraylist that has the specified number, that item is replaced. If the ItemByNumber property is being set and there is no item on the NamedArraylist that has the indicated number, the item is added. If the ItemByNumber property is being retrieved and there is no item on the NamedArraylist that has the indicated number, 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 property lets you retrieve or set an item using its item name.

See also