ItemByNumber (UnicodeNamedArraylist property): Difference between revisions

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

Latest revision as of 20:44, 5 August 2012