NameByNumber (NamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax table to diagram, tags and edits)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:NamedArraylist:NameByNumber subtitle}}
{{Template:NamedArraylist:NameByNumber subtitle}}


The <var>NameByNumber</var> ReadOnly property returns the name of the item that has the indicated item number in the <var>NamedArraylist</var>.
<var>NameByNumber</var> returns the name of the item that has the indicated item number in the <var>NamedArraylist</var>.


==Syntax==
==Syntax==
Line 7: Line 7:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%string</th>
<tr><th>%name</th>
<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>
<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>
<tr><th>nal</th>
<tr><th>nal</th>
Line 14: Line 14:
<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>
<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>
</table>
</table>
==Usage notes==
<ul><li>If the <var>NameByNumber</var> property is being retrieved and there is no item on the <var>NamedArraylist</var>that has the indicated item number, the result is one of the following actions:
<ul><li>The request is cancelled if the <var>[[UseDefault (NamedArraylist property)|UseDefault]]</var> property is <var class="code">False</var>.
<li>The <var>[[Default (NamedArraylist property)|Default]]</var> value is returned if the <var>UseDefault</var> property is <var class="code">True</var>.
</ul></ul>


==See also==
==See also==
<ul><li><var>[[Number (NamedArraylist property)|Number]]</var> lets you retrieve an item using its item number.</ul>
<ul>
<li><var>[[Number (NamedArraylist function)|Number]]</var> lets you retrieve an item using its item number.
<li><var>[[ItemByNumber_(GenericNamedArraylist_property)|ItemByNumber]]</var> lets you retrieve or set an item using the item's ordinal number.
</ul>
{{Template:NamedArraylist:NameByNumber footer}}
{{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.