Default (GenericNamedArraylist property): Difference between revisions
Jump to navigation
Jump to search
m (match syntax table to diagram, couple of tags, lots of edits) |
mNo edit summary |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:GenericNamedArraylist:Default subtitle}} | {{Template:GenericNamedArraylist:Default subtitle}} | ||
<var>Default</var> is a <var>[[Classes and Objects#readWrite|ReadWrite]]</var> property that specifies the value to be returned if ''both'' of these conditions are satisfied: | |||
<ul> | |||
<li>A requested item name is not present in the method <var>[[FloatNamedArraylist class|FloatNamedArraylist]]</var>, <var>[[NamedArraylist class|NamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class|UnicodeNamedArraylist]]</var>. | |||
<li>The <var>[[UseDefault (GenericNamedArraylist property)|UseDefault]]</var> property is set to <code>True</code>. | |||
</ul> | |||
==Syntax== | ==Syntax== | ||
{{Template:GenericNamedArraylist:Default syntax}} | {{Template:GenericNamedArraylist:Default syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%currentItem</th> | <tr><th>%currentItem</th> | ||
<td>A | <td>A variable of the <var class="term">anyNal</var> item type, or one that can be converted to from that type; it will receive the current default. </td></tr> | ||
<tr><th>anyNal</th> | <tr><th>anyNal</th> | ||
<td>A | <td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object.</td></tr> | ||
<tr><th>newItem</th> | <tr><th>newItem</th> | ||
<td>A new value that matches the | <td>A new value that matches the <var class="term">anyNal</var> item type, or one that can be converted to that type; that will become the new default.</td></tr> | ||
</table> | </table> | ||
| Line 20: | Line 25: | ||
<tr><th>Item type</th><th>Value</th></tr> | <tr><th>Item type</th><th>Value</th></tr> | ||
<tr><td>Float and Fixed</td><td>0</td></tr> | <tr><td>Float and Fixed</td><td>0</td></tr> | ||
<tr><td>String, | <tr><td>String, Longstring, and Unicode</td><td>null string</td></tr> | ||
<tr><td> | <tr><td>Object</td><td>null reference</td></tr> | ||
</table></ul> | </table></ul> | ||
==See also== | ==See also== | ||
{{Template:GenericNamedArraylist:Default footer}} | {{Template:GenericNamedArraylist:Default footer}} | ||
Latest revision as of 19:39, 1 November 2012
Value for Item to return when Name has no value (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)
Default is a ReadWrite property that specifies the value to be returned if both of these conditions are satisfied:
- A requested item name is not present in the method FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist.
- The UseDefault property is set to
True.
Syntax
%currentItem = anyNal:Default anyNal:Default = newItem
Syntax terms
| %currentItem | A variable of the anyNal item type, or one that can be converted to from that type; it will receive the current default. |
|---|---|
| anyNal | A FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist object. |
| newItem | A new value that matches the anyNal item type, or one that can be converted to that type; that will become the new default. |
Usage notes
- The initial value of the Default property varies with the array list item type:
Item type Value Float and Fixed 0 String, Longstring, and Unicode null string Object null reference