Difference between revisions of "Protected (ScreenField property)"

From m204wiki
Jump to navigation Jump to search
 
m
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This property sets or returns the Protected attribute for a ScreenField. A protected field does not allow user input, and is used for display only. Unprotected fields are used for user input. The Protected attribute is initially set for a field by the [[Screen class#AddField function|AddField method]].
+
{{Template:ScreenField:Protected subtitle}}
 +
The <var>Protected</var> property sets or returns the <var>Protected</var> attribute for a <var>ScreenField</var>. A protected field does not allow user input, and is used for display only. Unprotected fields are used for user input. The <var>Protected</var> attribute is initially set for a field by the <var>[[AddField_(Screen_function)|AddField]]</var> method.
  
  %sfield:Protected = bool
+
==Syntax==
  bool = %sfield:Protected
+
{{Template:ScreenField:Protected syntax}}
  
; Protected syntax
+
===Syntax terms===
 +
<table class="syntaxTable">
 +
<tr><th>%currentBoolean</th>
 +
<td>A <var>[[Boolean_enumeration|Boolean enumeration]]</var> to get the current value of the the <var>Protected</var> attribute applicable to <var class="term">sfield</var>.  Valid values are <var>True</var> and <var>False</var> (default).</td></tr>
  
; %sfield  
+
<tr><th>sfield</th>
: A reference to an instance of a ScreenField object.
+
<td>A reference to an instance of a <var>ScreenField</var> object.</td></tr>
  
; bool
+
<tr><th>newBoolean</th>
: A Boolean enumeration that indicates whether the field is protected. Valid values are True (default) and False.
+
<td>A <var>Boolean enumeration</var> to set the new value for the <var>Protected</var> attribute applicable to <var class="term">sfield</var>. Valid values are <var>True</var> and <var>False</var> (default)</td></tr>
 +
</table>
 +
 
 +
==See also==
 +
{{Template:ScreenField:Protected footer}}

Latest revision as of 19:51, 20 November 2012

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

The Protected property sets or returns the Protected attribute for a ScreenField. A protected field does not allow user input, and is used for display only. Unprotected fields are used for user input. The Protected attribute is initially set for a field by the AddField method.

Syntax

%currentBoolean = sfield:Protected sfield:Protected = newBoolean

Syntax terms

%currentBoolean A Boolean enumeration to get the current value of the the Protected 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 Protected attribute applicable to sfield. Valid values are True and False (default)

See also