NameByNumber (FloatNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
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-->
<p>
NameByNumber is a member of the [[FloatNamedArraylist class]].
</p>


This ReadOnly property returns the &ldquo;name&rdquo; (numerical subscript)
This ReadOnly property returns the "name" (numerical subscript)
of the item that has the specified
of the item that has the specified
item number (position) in the FloatNamedArraylist.
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">
<table class="syntaxTable">
Line 21: Line 15:
<td>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.</td></tr>
<td>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.</td></tr>
</table>
</table>
==Usage Notes==
==Usage notes==
<ul>
<ul>
<li>If the NameByNumber property is being retrieved and there is no item on the
<li>If the NameByNumber property is being retrieved and there is no item on the
Line 35: Line 29:
an item's content using its item number.
an item's content using its item number.
</ul>
</ul>
==See also==
{{Template:FloatNamedArraylist:NameByNumber footer}}

Revision as of 04:19, 7 February 2011

Name of specified item number (FloatNamedArraylist class)


This ReadOnly property returns the "name" (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 fnamrayl item.
%fnamrayl A FloatNamedArraylist object.
number 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.

Usage notes

  • If the NameByNumber property is being retrieved and there is no item on the FloatNamedArraylist that has the indicated item number, the result is one of the following actions:
    • The request is cancelled if the UseDefault property value is False.
    • The Default value is returned if the UseDefault property is True.
  • Number lets you retrieve an item's content using its item number.

See also