ProtectedHighlight (Screen property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
 
mNo edit summary
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This property gets or sets the current highlight default for protected fields in a Screen object. A protected field is assigned this highlight unless another highlight value is explicitly specified in the AddField statement that defines the field. A field's highlight can also be changed by the [[Screenfield class]] Highlight method.
{{Template:Screen:ProtectedHighlight subtitle}}
The <var>ProtectedHighlight</var> property gets or sets the current highlight default for protected fields in a <var>Screen</var> object. A protected field is assigned this highlight unless another highlight value is explicitly specified in the <var>[[AddField_(Screen_function)|AddField]]</var> statement that defines the field.


  %screen:ProtectedHighlight = highlight
An unprotected field's highlight can be changed by the <var>[[Highlight_(ScreenField_property)|Highlight]]</var> method.
  highlight = %screen:ProtectedHighlight


; <font size='3'>ProtectedHighlight syntax</font>
==Syntax==
{{Template:Screen:ProtectedHighlight syntax}}


; highlight
===Syntax terms===
: A Highlight enumeration. Valid values (case unimportant) are none, underline, reverse, and blink. The default value is none.
<table class="syntaxTable">
<tr><th>%currentHighlight</th>
<td>A <var>[[Highlight_(ScreenField_property)#Highlight_enumeration|Highlight enumeration]]</var> to get the current default highlight for protected fields. Valid values (case unimportant) are <code>none</code>, <code>underline</code>, <code>reverse</code>, and <code>blink</code>. The default value is <code>none</code>.</td></tr>


; %screen  
<tr><th>screen</th>
: A reference to an instance of a Screen object.
<td>A reference to an instance of a <var>Screen</var> object.</td></tr>
 
<tr><th>newHighlight</th>
<td>A <var>Highlight</var> enumeration setting the new defalt for a protected field's highlight. Valid values (case unimportant) are <code>none</code>, <code>underline</code>, <code>reverse</code>, and <code>blink</code>. The default value is <code>none</code>.</td></tr>
</table>
 
==See also==
{{Template:Screen:ProtectedHighlight footer}}

Latest revision as of 22:56, 16 November 2012

Set highlight color for protected screen fields (Screen class)

The ProtectedHighlight property gets or sets the current highlight default for protected fields in a Screen object. A protected field is assigned this highlight unless another highlight value is explicitly specified in the AddField statement that defines the field.

An unprotected field's highlight can be changed by the Highlight method.

Syntax

%currentHighlight = screen:ProtectedHighlight screen:ProtectedHighlight = newHighlight

Syntax terms

%currentHighlight A Highlight enumeration to get the current default highlight for protected fields. Valid values (case unimportant) are none, underline, reverse, and blink. The default value is none.
screen A reference to an instance of a Screen object.
newHighlight A Highlight enumeration setting the new defalt for a protected field's highlight. Valid values (case unimportant) are none, underline, reverse, and blink. The default value is none.

See also