NameByNumber (UnicodeNamedArraylist function): 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/>Name of specified item<section end=dpl_desc/></b></span> [[Category:UnicodeNamedArraylist methods|NameByNumb...")
 
 
(13 intermediate revisions by 5 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:UnicodeNamedArraylist:NameByNumber subtitle}}
[[Category:UnicodeNamedArraylist methods|NameByNumber property]]
 
<!--DPL?? Category:UnicodeNamedArraylist methods|NameByNumber property: Name of specified item-->
<var>NameByNumber</var> returns the subscript name of the item that has the specified item <var class="term">number</var> (position) in the <var>UnicodeNamedArraylist</var>.
<p>
NameByNumber is a member of the [[UnicodeNamedArraylist class]].
</p>


This ReadOnly property returns the subscript name
of the item that has the specified
item number (position) in the UnicodeNamedArraylist.
==Syntax==
==Syntax==
  name = %unamrayl:NameByNumber(number)
{{Template:UnicodeNamedArraylist:NameByNumber syntax}}
===Syntax Terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>name</i>
<tr><th>%name</th>
<dd>A Unicode string to contain the subscript name of the
<td>A Unicode string to contain the subscript name of the specified <var class="term">uniNal</var> item. </td></tr>
specified ''fnamrayl'' item.
<tr><th>uniNal</th>
<dt><i>%unamrayl</i>
<td>A <var>UnicodeNamedArraylist</var> object. </td></tr>
<dd>A UnicodeNamedArraylist object.
<tr><th>number</th>
<dt><i>number</i>
<td>A whole number greater than 0 to identify a <var class="term">uniNal</var> item by its position (item number) in the <var>UnicodeNamedArraylist</var>. If <var class="term">number</var> is greater than the number of items in <var class="term">uniNal</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 ''%unamrayl'' item
</table>
by its position (item number) in the UnicodeNamedArraylist.
 
If ''number'' is greater than the number of items in ''%unamrayl'',
==Examples==
or if it is less than or equal to zero, the request is cancelled.
For an example using <var>NameByNumber</var>, see [[UnicodeNamedArraylist class|"UnicodeNamedArraylist class"]].


</dl>
==See also==
==Usage Notes==
<ul>
<li>If the NameByNumber 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>
<ul>
<li>The request is cancelled if the
<li><var>[[Number (UnicodeNamedArraylist function)|Number]]</var> lets you retrieve an item's ordinal number using its item name.
[[UseDefault (UnicodeNamedArraylist property)|UseDefault]] property value is <tt>False</tt>.
<li><var>[[ItemByNumber_(GenericNamedArraylist_property)|ItemByNumber]]</var> lets you retrieve or set an item using the item's ordinal number.
<li>The [[Default (UnicodeNamedArraylist property)|Default]] value is returned if the
UseDefault property is <tt>True</tt>.
</ul>
<li>[[Number (UnicodeNamedArraylist property)|Number]] lets you retrieve
an item's content using its item number.
<li>For an example using the NameByNumber method, see [[UnicodeNamedArraylist class]].
</ul>
</ul>
{{Template:UnicodeNamedArraylist:NameByNumber footer}}

Latest revision as of 02:57, 8 August 2012

Name of specified item (UnicodeNamedArraylist class)


NameByNumber returns the subscript name of the item that has the specified item number (position) in the UnicodeNamedArraylist.

Syntax

%name = uniNal:NameByNumber( number)

Syntax terms

%name A Unicode string to contain the subscript name of the specified uniNal item.
uniNal A UnicodeNamedArraylist object.
number A whole number greater than 0 to identify a uniNal item by its position (item number) in the UnicodeNamedArraylist. If number is greater than the number of items in uniNal, or if it is less than or equal to zero, the request is cancelled.

Examples

For an example using NameByNumber, see "UnicodeNamedArraylist class".

See also

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