Number (NamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:NamedArraylist:Number subtitle}} | |||
This ReadOnly property returns the item number (ordinal) of the item that has the | This ReadOnly property returns the item number (ordinal) of the item that has the | ||
specified name in the NamedArraylist. | specified name in the NamedArraylist. | ||
==Syntax== | ==Syntax== | ||
{{Template:NamedArraylist:Number syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
| Line 20: | Line 14: | ||
<td>A string that serves as a subscript to identify a ''%namrayl'' item. If the indicated name is not in ''%namrayl'', <tt>0</tt> is returned, regardless of the setting of [[UseDefault (NamedArraylist property)|UseDefault]].</td></tr> | <td>A string that serves as a subscript to identify a ''%namrayl'' item. If the indicated name is not in ''%namrayl'', <tt>0</tt> is returned, regardless of the setting of [[UseDefault (NamedArraylist property)|UseDefault]].</td></tr> | ||
</table> | </table> | ||
==Usage | ==Usage notes== | ||
<ul> | <ul> | ||
<li>If the Number property is called and there is no item | <li>If the Number property is called and there is no item | ||
| Line 27: | Line 21: | ||
regardless of the setting of [[UseDefault (FloatNamedArraylist property)|UseDefault]]. | regardless of the setting of [[UseDefault (FloatNamedArraylist property)|UseDefault]]. | ||
</ul> | </ul> | ||
==See also== | |||
{{Template:NamedArraylist:Number footer}} | |||
Revision as of 04:19, 7 February 2011
Item number of specified name (NamedArraylist class)
This ReadOnly property returns the item number (ordinal) of the item that has the
specified name in the NamedArraylist.
Syntax
%number = nal:Number( name)
Syntax terms
| %num | A numeric variable to contain the number of the named %namrayl item. |
|---|---|
| %namrayl | A NamedArraylist object. |
| name | A string that serves as a subscript to identify a %namrayl item. If the indicated name is not in %namrayl, 0 is returned, regardless of the setting of UseDefault. |
Usage notes
- If the Number property is called and there is no item on the NamedArraylist that has the indicated subscript name, a 0 is returned, regardless of the setting of UseDefault.