Number (FloatNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (match syntax table to diagram, tags and edits (will need to be redone when syntax template is fixed)) |
||
| Line 1: | Line 1: | ||
{{Template:FloatNamedArraylist:Number subtitle}} | {{Template:FloatNamedArraylist:Number subtitle}} | ||
The <var>Number</var> ReadOnly property returns the item number (ordinal) of the item that has the specified subscript in the <var>FloatNamedArraylist</var>. | |||
specified subscript in the FloatNamedArraylist. | |||
==Syntax== | ==Syntax== | ||
{{Template:FloatNamedArraylist:Number syntax}} | {{Template:FloatNamedArraylist: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 item number of the specified | <td>A numeric variable to contain the item number of the specified <var class="term">fltNal</var> item. </td></tr> | ||
<tr><th> | <tr><th>fltNal</th> | ||
<td>A FloatNamedArraylist object. </td></tr> | <td>A <var>FloatNamedArraylist</var> object. </td></tr> | ||
<tr><th> | <tr><th>number</th> | ||
<td>A numeric value that serves as a subscript to identify a | <td>A numeric value that serves as a subscript to identify a <var class="term">fltNal</var> item.</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>FloatNamedArraylist</var> that has the indicated subscript, a <var class="code">0</var> is returned, regardless of the setting of <var>[[UseDefault (FloatNamedArraylist property)|UseDefault]]</var>. | ||
on the FloatNamedArraylist that has the indicated subscript, | |||
a < | |||
regardless of the setting of [[UseDefault (FloatNamedArraylist property)|UseDefault]]. | |||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:FloatNamedArraylist:Number footer}} | {{Template:FloatNamedArraylist:Number footer}} | ||
Revision as of 11:09, 8 March 2011
Item number of specified name (FloatNamedArraylist class)
The Number ReadOnly property returns the item number (ordinal) of the item that has the specified subscript in the FloatNamedArraylist.
Syntax
%number = fltNal:Number( subscript)
Syntax terms
| %number | A numeric variable to contain the item number of the specified fltNal item. |
|---|---|
| fltNal | A FloatNamedArraylist object. |
| number | A numeric value that serves as a subscript to identify a fltNal item. |
Usage notes
- If Number is called and there is no item on the FloatNamedArraylist that has the indicated subscript, a 0 is returned, regardless of the setting of UseDefault.