NameByNumber (FloatNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (match syntax table to diagram, tags and edits) |
||
| Line 1: | Line 1: | ||
{{Template:FloatNamedArraylist:NameByNumber subtitle}} | {{Template:FloatNamedArraylist:NameByNumber subtitle}} | ||
The <var>NameByNumber</var> ReadOnly property returns the "name" (numerical subscript) of the item that has the specified item number (position) in the <var>FloatNamedArraylist</var>. | |||
of the item that has the specified | |||
item number (position) in the FloatNamedArraylist. | |||
==Syntax== | ==Syntax== | ||
{{Template:FloatNamedArraylist:NameByNumber syntax}} | {{Template:FloatNamedArraylist:NameByNumber syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%number</th> | ||
<td>A numeric variable to contain the subscript of the specified | <td>A numeric variable to contain the subscript of the specified <var class="term">fltNal</var> item. </td></tr> | ||
<tr><th> | <tr><th>fltNal</th> | ||
<td>A FloatNamedArraylist object. </td></tr> | <td>A <var>FloatNamedArraylist</var> object. </td></tr> | ||
<tr><th>number</th> | <tr><th>number</th> | ||
<td>A whole number greater than 0 to identify a | <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> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul><li>If the <var>NameByNumber</var> property is being retrieved and there is no item on the </var>FloatNamedArraylist</var> that has the indicated item number, the result is one of the following actions: | ||
<li>If the NameByNumber property is being retrieved and there is no item on the | <ul><li>The request is cancelled if the <var>[[UseDefault (FloatNamedArraylist property)|UseDefault]]</var> property value is <var class="code">False</var>. | ||
FloatNamedArraylist that has the indicated item number, | <li>The <var>[[Default (FloatNamedArraylist property)|Default]]</var> value is returned if the <var>UseDefault</var> property is <var class="code">True</var>. | ||
the result is one of the following actions: | </ul></ul> | ||
<ul> | |||
<li>The request is cancelled if the | |||
[[UseDefault (FloatNamedArraylist property)|UseDefault]] property value is < | |||
<li>The [[Default (FloatNamedArraylist property)|Default]] value is returned if the | |||
UseDefault property is < | |||
</ul> | |||
</ul> | |||
==See also== | ==See also== | ||
<ul><li><var>[[Number (FloatNamedArraylist property)|Number]]</var> lets you retrieve an item's content using its item number.</ul> | |||
{{Template:FloatNamedArraylist:NameByNumber footer}} | {{Template:FloatNamedArraylist:NameByNumber footer}} | ||
Revision as of 10:49, 8 March 2011
Name of specified item number (FloatNamedArraylist class)
The NameByNumber 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
| %number | 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. |
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.
See also
- Number lets you retrieve an item's content using its item number.