NameByNumber (FloatNamedArraylist function): Difference between revisions

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


This ReadOnly property returns the &ldquo;name&rdquo; (numerical subscript)
of the item that has the specified
item number (position) in the FloatNamedArraylist.
==Syntax==
==Syntax==
<p class="code">%subscript = %fnamrayl:NameByNumber(number)
{{Template:FloatNamedArraylist:NameByNumber syntax}}
</p>
===Syntax terms===
===Syntax Terms===
<table class="syntaxTable">
<dl>
<tr><th>%subscript</th>
<dt><i>%subscript</i>
<td>A numeric variable to contain the subscript of the specified <var class="term">fltNal</var> item. </td></tr>
<dd>A numeric variable to contain the subscript of the
<tr><th>fltNal</th>
specified ''fnamrayl'' item.
<td>A <var>FloatNamedArraylist</var> object. </td></tr>
<dt><i>%fnamrayl</i>
<tr><th>number</th>
<dd>A FloatNamedArraylist object.
<td>A whole number greater than 0 to identify a <var class="term">fltNal</var> item by its position (item number) in the numerically ordered <var>FloatNamedArraylist</var>. If <var class="term">number</var> is greater than the number of items in <var class="term">fltNal</var>, or if it is less than or equal to zero, the request is cancelled.</td></tr>
<dt><i>number</i>
</table>
<dd>A whole number greater than 0 to identify a ''%fnamrayl'' item
by its position (item number) in the numerically ordered 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>
==See also==
==Usage Notes==
<ul>
<ul>
<li>If the NameByNumber property is being retrieved and there is no item on the
<li><var>[[Number (FloatNamedArraylist function)|Number]]</var> lets you retrieve an item's ordinal number using its numeric subscript.
FloatNamedArraylist 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 (FloatNamedArraylist property)|UseDefault]] property value is <tt>False</tt>.
<li>The [[Default (FloatNamedArraylist property)|Default]] value is returned if the
UseDefault property is <tt>True</tt>.
</ul>
<li>[[Number (FloatNamedArraylist property)|Number]] lets you retrieve
an item's content using its item number.
</ul>
</ul>
{{Template:FloatNamedArraylist:NameByNumber footer}}

Latest revision as of 02:57, 8 August 2012

Name of specified item number (FloatNamedArraylist class)


NameByNumber returns the "name" (in this case a numerical subscript) of the item that has the specified item number (position) in the FloatNamedArraylist.

Syntax

%subscript = fltNal:NameByNumber( number)

Syntax terms

%subscript A numeric variable to contain the subscript of the specified fltNal item.
fltNal A FloatNamedArraylist object.
number A whole number greater than 0 to identify a fltNal item by its position (item number) in the numerically ordered FloatNamedArraylist. If number is greater than the number of items in fltNal, or if it is less than or equal to zero, the request is cancelled.

See also

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