NameByNumber (NamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<span style="font-size:120%; color:black"><b><section begin=dpl_desc/>Name of specified item<section end=dpl_desc/></b></span>
{{Template:NamedArraylist:NameByNumber subtitle}}
[[Category:NamedArraylist methods|NameByNumber property]]
 
<!--DPL?? Category:NamedArraylist methods|NameByNumber property: Name of specified item-->
<var>NameByNumber</var> returns the name of the item that has the indicated item number in the <var>NamedArraylist</var>.
<p>
NameByNumber is a member of the [[NamedArraylist class]].
</p>


This ReadOnly property returns the name of the item that has the indicated
item number in the NamedArraylist.
==Syntax==
==Syntax==
  %name = %namrayl:NameByNumber(number)
{{Template:NamedArraylist:NameByNumber syntax}}
===Syntax Terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>%name</i>
<tr><th>%name</th>
<dd>A string variable to contain the name of the ''namrayl'' item
<td>A string variable to contain the name of the <var class="term">nal</var> item that is specified by <var class="term">number</var>. </td></tr>
that is specified by ''number''.
<tr><th>nal</th>
<dt><i>%namrayl</i>
<td>A <var>NamedArraylist</var> object. </td></tr>
<dd>A NamedArraylist object.
<tr><th>number</th>
<dt><i>number</i>
<td>A whole number greater than 0 to identify a <var class="term">nal</var> item by its position (item number) in the alphabetically ordered <var>NamedArraylist</var>. If <var class="term">number</var> is greater than the number of items in <var class="term">nal</var>, or if it is less than or equal to zero, the request is cancelled.</td></tr>
<dd>A whole number greater than 0 to identify a ''%namrayl'' item
</table>
by its position (item number) 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.


</dl>
==See also==
==Usage Notes==
<ul>
<ul>
<li>If the NameByNumber property is being retrieved and there is no item on the
<li><var>[[Number (NamedArraylist function)|Number]]</var> lets you retrieve an item using its item number.
NamedArraylist that has the indicated item number,
<li><var>[[ItemByNumber_(GenericNamedArraylist_property)|ItemByNumber]]</var> lets you retrieve or set an item using the item's ordinal number.
the result is one of the following actions:
<ul>
<li>The request is cancelled if the
[[UseDefault (NamedArraylist property)|UseDefault]] property is <tt>False</tt>.
<li>The [Default (NamedArraylist property)|Default]] value is returned if the
UseDefault property is <tt>True</tt>.
</ul>
<li>The [[Number (NamedArraylist property)|Number]] property lets you retrieve
an item using its item number.
</ul>
</ul>
{{Template:NamedArraylist:NameByNumber footer}}

Latest revision as of 02:58, 8 August 2012

Name of specified item number (NamedArraylist class)


NameByNumber returns the name of the item that has the indicated item number in the NamedArraylist.

Syntax

%name = nal:NameByNumber( number)

Syntax terms

%name A string variable to contain the name of the nal item that is specified by number.
nal A NamedArraylist object.
number A whole number greater than 0 to identify a nal item by its position (item number) in the alphabetically ordered NamedArraylist. If number is greater than the number of items in nal, or if it is less than or equal to zero, the request is cancelled.

See also

  • Number lets you retrieve an item using its item number.
  • ItemByNumber lets you retrieve or set an item using the item's ordinal number.