Numeric (ScreenField property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:ScreenField:Numeric subtitle}}
{{Template:ScreenField:Numeric subtitle}}
The <var>Numeric</var> property sets or returns the <var>Numeric</var> attribute for a <var>ScreenField</var>.  If a field is <var>Numeric</var>, only numeric values may be entered in the field.  The <var>Numeric</var> attribute is initially set for a field by the <var>[[AddField_(Screen_function)|AddField]]</var> method.


This property sets or returns the Numeric attribute for a ScreenField. If a field is Numeric, only numeric values may be entered in the field. The Numeric attribute is
initially set for a field by the [[Screen class#AddField function|AddField method]].
==Syntax==
==Syntax==
{{Template:ScreenField:Numeric syntax}}
{{Template:ScreenField:Numeric syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt>bool
<tr><th>%currentBoolean</th>
<dd>A Boolean enumeration. Valid values are True (default) and False. A value is numeric only if it is composed of the characters 0 through 9, plus (+), minus (-), or period (.).
<td>A <var>[[Boolean_enumeration|Boolean enumeration]]</var> to get the current value of the <var>Numeric</var> attribute applicable to <var class="term">sfield</var>. Valid values are <var>True</var> and <var>False</var> (default). </td></tr>
<dt>%sfield
 
<dd>A reference to an instance of a ScreenField object.
<tr><th>sfield</th>
</dl>
<td>A reference to an instance of a <var>ScreenField</var> object.</td></tr>
 
<tr><th>newBoolean</th>
<td>A <var>Boolean enumeration</var> to set the new value for the <var>Numeric</var> attribute applicable to <var class="term">sfield</var>.  Valid values are <var>True</var> and <var>False</var> (default)</td></tr>
</table>


==Usage notes==
==Usage notes==
<ul>
<li>Regardless of the value of a field's <var>Numeric</var> attribute, the programmer can assign any type of value to the field.  Enforcement of the <var>Numeric</var> attribute takes place only when a user enters data in the field.
<li>Some terminal emulators do not enforce numeric field restrictions, so the programmer should be aware that the value of a numeric field must still be checked for validity. A value is numeric only if it is composed of the characters <code>0</code> through <code>9</code>, plus (<code>+</code>), minus (<code>-</code>), or period (<code>.</code>).
</ul>


Regardless of the value of a field's Numeric attribute, the programmer can assign any type of value to the field. Enforcement of the Numeric attribute takes place only when a user enters data in the field. Some terminal emulators do not enforce numeric field restrictions, so the programmer should be aware that the value of a numeric field must still be checked for validity.
==See also==
==See also==
{{Template:ScreenField:Numeric footer}}
{{Template:ScreenField:Numeric footer}}

Latest revision as of 19:49, 20 November 2012

Set or return the numeric attribute for screenfield (ScreenField class)

The Numeric property sets or returns the Numeric attribute for a ScreenField. If a field is Numeric, only numeric values may be entered in the field. The Numeric attribute is initially set for a field by the AddField method.

Syntax

%currentBoolean = sfield:Numeric sfield:Numeric = newBoolean

Syntax terms

%currentBoolean A Boolean enumeration to get the current value of the Numeric attribute applicable to sfield. Valid values are True and False (default).
sfield A reference to an instance of a ScreenField object.
newBoolean A Boolean enumeration to set the new value for the Numeric attribute applicable to sfield. Valid values are True and False (default)

Usage notes

  • Regardless of the value of a field's Numeric attribute, the programmer can assign any type of value to the field. Enforcement of the Numeric attribute takes place only when a user enters data in the field.
  • Some terminal emulators do not enforce numeric field restrictions, so the programmer should be aware that the value of a numeric field must still be checked for validity. A value is numeric only if it is composed of the characters 0 through 9, plus (+), minus (-), or period (.).

See also