Default (GenericNamedArraylist property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax table to diagram, couple of tags, lots of edits)
m (It's not just a namedarraylist anymore Toto)
Line 1: Line 1:
{{Template:GenericNamedArraylist:Default subtitle}}
{{Template:GenericNamedArraylist:Default subtitle}}


The <var>Default</var> ReadWrite property indicates the value to be returned if a requested item name is not in the method <var>FloatNamedArraylist</var> / <var>NamedArraylist</var> / <var>UnicodeNamedArraylist</var> and the <var>[[UseDefault (NamedArraylist property)|UseDefault]]</var> property is set to <code>True</code>.
The <var>Default</var> ReadWrite property controls 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>.


==Syntax==
==Syntax==
Line 8: Line 8:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%currentItem</th>
<tr><th>%currentItem</th>
<td>A value that matches the array list item type, or one that can be converted to that type; that will receive the current default. </td></tr>
<td>A value that matches the <var class="term">anyNal</var> item type, or one that can be converted to that type; that will receive the current default. </td></tr>
<tr><th>anyNal</th>
<tr><th>anyNal</th>
<td>A array list object.</td></tr>
<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 array list item type, or one that can be converted to that type; that will become the new default.</td></tr>
<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>



Revision as of 09:39, 3 March 2011

Value for Item to return when Name has no value (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)


The Default ReadWrite property controls the value to be returned if a requested item name is not in the method FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist; and the UseDefault property is set to True.

Syntax

%currentItem = anyNal:Default anyNal:Default = newItem

Syntax terms

%currentItem A value that matches the anyNal item type, or one that can be converted to that type; that 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