Protected (ScreenField property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:ScreenField:Protected subtitle}}
{{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.


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]].
==Syntax==
==Syntax==
{{Template:ScreenField:Protected syntax}}
{{Template:ScreenField:Protected syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt>%sfield
<tr><th>%currentBoolean</th>
<dd>A reference to an instance of a ScreenField object.
<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>
<dt>bool
 
<dd>A Boolean enumeration that indicates whether the field is protected. Valid values are True (default) and False.
<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>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==
==See also==
{{Template:ScreenField:Protected footer}}
{{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