Default (GenericNamedArraylist property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Template:GenericNamedArraylist:Default subtitle}}
{{Template:GenericNamedArraylist:Default subtitle}}


The <var>Default</var> ReadWrite property is the value to be returned if a requested item name is not in the method <var>[[FloatNamedArraylist class|FloatNamedArraylist]]</var>, <var>[[NamedArraylist class|NamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class|UnicodeNamedArraylist]]</var>; <b><i>and</i></b> the <var>[[UseDefault (NamedArraylist property)|UseDefault]]</var> property is set to <code>True</code>.
<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 value that matches the <var class="term">anyNal</var> item type, or one that can be converted to that type; it will receive the current default. </td></tr>
<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 <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object.</td></tr>
<td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object.</td></tr>
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, <var>Longstring</var>, and Unicode</td><td>null string</td></tr>
<tr><td>String, Longstring, and Unicode</td><td>null string</td></tr>
<tr><td>object</td><td>null reference</td></tr>
<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:

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 typeValue
    Float and Fixed0
    String, Longstring, and Unicodenull string
    Objectnull reference

See also