UseDefault (GenericNamedArraylist property): Difference between revisions
m (1 revision) |
m (minor spelling correction) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:GenericNamedArraylist:UseDefault subtitle}} | {{Template:GenericNamedArraylist:UseDefault subtitle}} | ||
<var>Flag</var> is a ReadWrite property indicates whether an attempted retrieval of an item that is not in the <var>[[FloatNamedArraylist class|FloatNamedArraylist]]</var>, <var>[[NamedArraylist class|NamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class|UnicodeNamedArraylist]]</var> should result in request cancellation of return the <var>[[Default (NamedArraylist property)|Default]]</var> property value. | |||
==Syntax== | ==Syntax== | ||
{{Template:GenericNamedArraylist:UseDefault syntax}} | {{Template:GenericNamedArraylist:UseDefault syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%currentBoolean</th> | ||
<td>A declared enumeration object of type Boolean to | <td>A declared enumeration object of type Boolean into which the current value (<code>True</code> or <code>False</code>) will be returned. | ||
<tr><th>anyNal</th> | |||
<td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object.</td></tr> | |||
<tr><th>newBoolean</th> | |||
<td>A boolean literal or declared enumeration, to set the new value of <var>UseDefault</var> property.</td></tr> | |||
</table> | |||
==Usage Notes== | |||
<ul><li><var>UseDefault</var> will return, or may be assigned, only the boolean values <code>True</code> or <code>False</code>. Its initial, default value is <code>False</code>. | |||
</ul> | |||
==Examples== | |||
Given the following fragment: | |||
<p class="code">%nal is namedArraylist of string len 30 | |||
%nal = new | |||
%nal('Akron') = 'Rubber City' | |||
%nal('Atlanta') = 'The Athens of the South' | |||
%nal('Philadelphia') = 'City of Brotherly love' | |||
print %nal('Philadelphia') with '!' | |||
%nal:useDefault = true | |||
print %nal('Boston') with '!' | |||
%nal:useDefault = false | |||
print %nal('Boston') with '!' | |||
</p> | |||
The result is: | |||
<p class="output"><nowiki> | |||
City of Brotherly love! | |||
! | |||
*** 1 CANCELLING REQUEST: MSIR.0751: Class NamedArraylist, property Item: | |||
ItemNotPresent exception: item not present in line ... | |||
</nowiki></p> | |||
Notice that the first <code>print %nal('Boston')</code> outputs the null string (the default value for the <code>string len 30</code> item type) because of the preceding <code>%nal:useDefault = true</code>, but then when set to <code>false</code> the same <code>item</code> invocation cancels the request. | |||
==See also== | ==See also== | ||
<ul><li>For more information about these enumerations, see [[Enumerations#Using_Boolean_enumerations|"Using Boolean Enumerations"]]. | |||
</ul> | |||
{{Template:GenericNamedArraylist:UseDefault footer}} | {{Template:GenericNamedArraylist:UseDefault footer}} | ||
Latest revision as of 16:57, 30 September 2016
Flag indicating whether or not Item returns the Default value when name has no value (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)
Flag is a ReadWrite property indicates whether an attempted retrieval of an item that is not in the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist should result in request cancellation of return the Default property value.
Syntax
%currentBoolean = anyNal:UseDefault anyNal:UseDefault = newBoolean
Syntax terms
| %currentBoolean | A declared enumeration object of type Boolean into which the current value (True or False) will be returned.
|
|---|---|
| anyNal | A FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist object. |
| newBoolean | A boolean literal or declared enumeration, to set the new value of UseDefault property. |
Usage Notes
- UseDefault will return, or may be assigned, only the boolean values
TrueorFalse. Its initial, default value isFalse.
Examples
Given the following fragment:
%nal is namedArraylist of string len 30 %nal = new %nal('Akron') = 'Rubber City' %nal('Atlanta') = 'The Athens of the South' %nal('Philadelphia') = 'City of Brotherly love' print %nal('Philadelphia') with '!' %nal:useDefault = true print %nal('Boston') with '!' %nal:useDefault = false print %nal('Boston') with '!'
The result is:
City of Brotherly love! ! *** 1 CANCELLING REQUEST: MSIR.0751: Class NamedArraylist, property Item: ItemNotPresent exception: item not present in line ...
Notice that the first print %nal('Boston') outputs the null string (the default value for the string len 30 item type) because of the preceding %nal:useDefault = true, but then when set to false the same item invocation cancels the request.
See also
- For more information about these enumerations, see "Using Boolean Enumerations".