NameByNumber (NamedArraylist 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:NamedArraylist:NameByNumber subtitle}} | {{Template:NamedArraylist:NameByNumber subtitle}} | ||
The <var>NameByNumber</var> ReadOnly property returns the name of the item that has the indicated item number in the <var>NamedArraylist</var>. | |||
item number in the NamedArraylist. | |||
==Syntax== | ==Syntax== | ||
{{Template:NamedArraylist:NameByNumber syntax}} | {{Template:NamedArraylist:NameByNumber syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%string</th> | ||
<td>A string variable to contain the name of the | <td>A string variable to contain the name of the <var class="term">nal</var> item that is specified by <var class="term">number</var>. </td></tr> | ||
<tr><th> | <tr><th>nal</th> | ||
<td>A NamedArraylist object. </td></tr> | <td>A <var>NamedArraylist</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">nal</var> item by its position (item number) in the alphabetically ordered <var>NamedArraylist</var>. If <var class="term">number</var> is greater than the number of items in <var class="term">nal</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>NamedArraylist</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 (NamedArraylist property)|UseDefault]]</var> property is <var class="code">False</var>. | ||
NamedArraylist that has the indicated item number, | <li>The <var>[[Default (NamedArraylist 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 (NamedArraylist property)|UseDefault]] property is < | |||
<li>The [Default (NamedArraylist property)|Default]] value is returned if the | |||
UseDefault property is < | |||
</ul> | |||
</ul> | |||
==See also== | ==See also== | ||
<ul><li><var>[[Number (NamedArraylist property)|Number]]</var> lets you retrieve an item using its item number.</ul> | |||
{{Template:NamedArraylist:NameByNumber footer}} | {{Template:NamedArraylist:NameByNumber footer}} | ||
Revision as of 10:56, 8 March 2011
Name of specified item number (NamedArraylist class)
The NameByNumber ReadOnly property returns the name of the item that has the indicated item number in the NamedArraylist.
Syntax
%name = nal:NameByNumber( number)
Syntax terms
| %string | A string variable to contain the name of the nal item that is specified by number. |
|---|---|
| nal | A NamedArraylist object. |
| number | A whole number greater than 0 to identify a nal item by its position (item number) in the alphabetically ordered NamedArraylist. If number is greater than the number of items in nal, 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 NamedArraylistthat 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 value is returned if the UseDefault property is True.
See also
- Number lets you retrieve an item using its item number.