ItemByNumber (FloatNamedArraylist property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
 
Line 1: Line 1:
<span style="font-size:120%; color:black"><b><section begin=dpl_desc/>Value of item selected by item<section end=dpl_desc/></b></span>
#REDIRECT [[ItemByNumber (GenericNamedArraylist property)]]
[[Category:FloatNamedArraylist methods|ItemByNumber property]]
<!--DPL?? Category:FloatNamedArraylist methods|ItemByNumber property: Value of item selected by item-->
<p>
ItemByNumber is a member of the [[FloatNamedArraylist class]].
</p>
 
This ReadWrite property returns or sets the FloatNamedArraylist item that has
the specified item number.
Item number is ordinal, so
ItemByNumber(3), for example, identifies the third item in the
numerically ordered FloatNamedArraylist.
==Syntax==
  %item = %fnamrayl:ItemByNumber(number)
 
  %fnamrayl:ItemByNumber(number) = %item
===Syntax Terms===
<dl>
<dt><i>%item</i>
<dd>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.
<dt><i>%fnamrayl</i>
<dd>A FloatNamedArraylist object.
<dt><i>number</i>
<dd>A whole number greater than 0 to identify a ''%fnamrayl'' item
by its position in the FloatNamedArraylist.
If ''number'' is greater than the number of items in ''%fnamrayl'',
or if it is less than or equal to zero, the request is cancelled.
 
</dl>
==Usage Notes==
<ul>
<li>If the ItemByNumber property is being set and there is already an item
on the FloatNamedArraylist that has the specified item number (position),
that item is replaced.
 
If the ItemByNumber property is being set and there is no item on the
FloatNamedArraylist that has the indicated item number, the item is added.
 
If the ItemByNumber property is being retrieved and there is no item on the
FloatNamedArraylist that has the indicated item number,
the result is one of the following actions:
<ul>
<li>The request is cancelled if the
[[UseDefault (FloatNamedArraylist property)|UseDefault]] value is <tt>False</tt>.
<li>The [[Default (FloatNamedArraylist property)|Default]] value is returned if the
UseDefault property is <tt>True</tt>.
</ul>
<li>[[Item (FloatNamedArraylist property)|Item]] lets you retrieve or
set an item using its item subscript number.
</ul>

Latest revision as of 20:45, 5 August 2012