Number (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:Number subtitle}} | {{Template:NamedArraylist:Number subtitle}} | ||
The <var>Number</var> ReadOnly property returns the item number (ordinal) of the item that has the specified name in the <var>NamedArraylist</var>. | |||
specified name in the NamedArraylist. | |||
==Syntax== | ==Syntax== | ||
{{Template:NamedArraylist:Number syntax}} | {{Template:NamedArraylist:Number syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%number</th> | ||
<td>A numeric variable to contain the number of the named | <td>A numeric variable to contain the number of the named <var class="term">nal</var> item. </td></tr> | ||
<tr><th>% | <tr><th>%nal</th> | ||
<td>A NamedArraylist object. </td></tr> | <td>A <var>NamedArraylist</var> object. </td></tr> | ||
<tr><th> | <tr><th>string</th> | ||
<td>A string that serves as a subscript to identify a | <td>A string that serves as a subscript to identify a <var class="term">nal</var> item. If the indicated name is not in <var class="term">nal</var>, <var class="output">0</var> is returned, regardless of the setting of <var>[[UseDefault (NamedArraylist property)|UseDefault]]</var>.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>If | <li>If <var>Number</var> is called and there is no item on the <var>NamedArraylist</var> that has the indicated subscript name, a <var class="output">0</var> is returned, regardless of the setting of <var>[[UseDefault (FloatNamedArraylist property)|UseDefault]]</var>. | ||
on the NamedArraylist that has the indicated subscript name, | |||
a < | |||
regardless of the setting of [[UseDefault (FloatNamedArraylist property)|UseDefault]]. | |||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:NamedArraylist:Number footer}} | {{Template:NamedArraylist:Number footer}} | ||
Revision as of 11:13, 8 March 2011
Item number of specified name (NamedArraylist class)
The Number 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
| %number | A numeric variable to contain the number of the named nal item. |
|---|---|
| %nal | A NamedArraylist object. |
| string | A string that serves as a subscript to identify a nal item. If the indicated name is not in nal, 0 is returned, regardless of the setting of UseDefault. |
Usage notes
- If Number 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.