NameByNumber (NamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
Line 1: | Line 1: | ||
{{Template:NamedArraylist:NameByNumber subtitle}} | |||
This ReadOnly property returns the name of the item that has the indicated | This ReadOnly property returns the name of the item that has the indicated | ||
item number in the NamedArraylist. | item number in the NamedArraylist. | ||
==Syntax== | ==Syntax== | ||
{{Template:NamedArraylist:NameByNumber syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
Line 20: | Line 14: | ||
<td>A whole number greater than 0 to identify a ''%namrayl'' item by its position (item number) in the alphabetically ordered NamedArraylist. If ''number'' is greater than the number of items in ''%namrayl'', 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 ''%namrayl'' item by its position (item number) in the alphabetically ordered NamedArraylist. If ''number'' is greater than the number of items in ''%namrayl'', or if it is less than or equal to zero, the request is cancelled.</td></tr> | ||
</table> | </table> | ||
==Usage | ==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 34: | Line 28: | ||
an item using its item number. | an item using its item number. | ||
</ul> | </ul> | ||
==See also== | |||
{{Template:NamedArraylist:NameByNumber footer}} |
Revision as of 04:19, 7 February 2011
Name of specified item number (NamedArraylist class)
This ReadOnly property 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 namrayl item that is specified by number. |
---|---|
%namrayl | A NamedArraylist object. |
number | A whole number greater than 0 to identify a %namrayl item by its position (item number) in the alphabetically ordered NamedArraylist. If number is greater than the number of items in %namrayl, 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
NamedArraylist that has the indicated item number,
the result is one of the following actions:
- The request is cancelled if the UseDefault property is False.
- The [Default (NamedArraylist property)|Default]] value is returned if the UseDefault property is True.
- The Number property lets you retrieve an item using its item number.