NameByNumber (UnicodeNamedArraylist 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:UnicodeNamedArraylist:NameByNumber subtitle}} | {{Template:UnicodeNamedArraylist:NameByNumber subtitle}} | ||
The <var>NameByNumber</var> ReadOnly property returns the subscript name of the item that has the specified item <var class="term">number</var> (position) in the <var>UnicodeNamedArraylist</var>. | |||
of the item that has the specified | |||
item number (position) in the UnicodeNamedArraylist. | |||
==Syntax== | ==Syntax== | ||
{{Template:UnicodeNamedArraylist:NameByNumber syntax}} | {{Template:UnicodeNamedArraylist:NameByNumber syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th> | <tr><th>%unicode</th> | ||
<td>A Unicode string to contain the subscript name of the specified | <td>A Unicode string to contain the subscript name of the specified <var class="term">uniNal</var> item. </td></tr> | ||
<tr><th> | <tr><th>uniNal</th> | ||
<td>A UnicodeNamedArraylist object. </td></tr> | <td>A <var>UnicodeNamedArraylist</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">uniNal</var> item by its position (item number) in the <var>UnicodeNamedArraylist</var>. If <var class="term">number</var> is greater than the number of items in <var class="term">uniNal</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>UnicodeNamedArraylist</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 (UnicodeNamedArraylist property)|UseDefault]]</var> property value is <var class="code">False</var>. | ||
UnicodeNamedArraylist that has the indicated item number, | <li>The <var>[[Default (UnicodeNamedArraylist 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 | ==Examples== | ||
[[UseDefault (UnicodeNamedArraylist property)|UseDefault]] property value is < | <ol><li>For an example using <var>NameByNumber</var>, see [[UnicodeNamedArraylist class|"UnicodeNamedArraylist class"]].</ol> | ||
<li>The [[Default (UnicodeNamedArraylist property)|Default]] value is returned if the | |||
UseDefault property is < | |||
</ul> | |||
< | |||
<li>For an example using | |||
</ | |||
==See also== | ==See also== | ||
<ul><li><var>[[Number (UnicodeNamedArraylist property)|Number]]</var> lets you retrieve an item's content using its item number.</ul> | |||
{{Template:UnicodeNamedArraylist:NameByNumber footer}} | {{Template:UnicodeNamedArraylist:NameByNumber footer}} | ||
Revision as of 11:03, 8 March 2011
Name of specified item (UnicodeNamedArraylist class)
The NameByNumber ReadOnly property returns the subscript name of the item that has the specified item number (position) in the UnicodeNamedArraylist.
Syntax
%name = uniNal:NameByNumber( number)
Syntax terms
| %unicode | A Unicode string to contain the subscript name of the specified uniNal item. |
|---|---|
| uniNal | A UnicodeNamedArraylist object. |
| number | A whole number greater than 0 to identify a uniNal item by its position (item number) in the UnicodeNamedArraylist. If number is greater than the number of items in uniNal, 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 UnicodeNamedArraylist 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.
Examples
- For an example using NameByNumber, see "UnicodeNamedArraylist class".
See also
- Number lets you retrieve an item's content using its item number.