ProtectedColor (Screen property): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (match syntax table to syntax template; edits, tags and links) |
||
| Line 1: | Line 1: | ||
{{Template:Screen:ProtectedColor subtitle}} | {{Template:Screen:ProtectedColor subtitle}} | ||
The <var>ProtectedColor</var> property sets or gets the current default for the color of protected fields in a <var>Screen</var> object. A protected field is assigned this color unless another color value is explicitly specified in the <var>[[AddField_(Screen_function)|AddField]]</var> statement that defines the field. | |||
An unprotected field's color can also be changed by the <var>[[Color_(ScreenField_property)|Color]]</var> method. | |||
==Syntax== | ==Syntax== | ||
{{Template:Screen:ProtectedColor syntax}} | {{Template:Screen:ProtectedColor syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th> | <tr><th><var>currentFieldColor</var></th> | ||
<td>A Fieldcolor enumeration. Valid values (case unimportant) are turquoise, green, blue, red, white, yellow, and pink. The default value is blue. </td></tr> | <td>A <var>[[Color_(ScreenField_property)#FieldColor_enumeration|Fieldcolor enumeration]]</var> to get the current default color for protected fields. Valid values (case unimportant) are <code>turquoise</code>, <code>green</code>, <code>blue</code>, <code>red</code>, <code>white</code>, <code>yellow</code>, and <code>pink</code>. The default value is <code>blue</code>.</td></tr> | ||
<tr><th> | <tr><th><var>screen</var></th> | ||
<td>A reference to an instance of a Screen object.</td></tr> | <td>A reference to an instance of a <var>Screen</var> object.</td></tr><tr> | ||
<th><var>newFieldColor</var></th> | |||
<td>A <var>Fieldcolor</var> enumeration to set the new protected field's color. Valid values (case unimportant) are <code>turquoise</code>, <code>green</code>, <code>blue</code>, <code>red</code>, <code>white</code>, <code>yellow</code>, and <code>pink</code>. The default value is <code>blue</code>.</td></tr> | |||
</table> | </table> | ||
==Examples== | ==Examples== | ||
<ol><li>The following statement prints the color of the %scr screen: | |||
<p class="code"> print %scr:protectedColor:ToString | |||
</p></ol> | |||
==See also== | ==See also== | ||
<ul><li>An unprotected field's color can also be changed by the <var>Color</var> method.</ul> | |||
{{Template:Screen:ProtectedColor footer}} | {{Template:Screen:ProtectedColor footer}} | ||
Revision as of 00:39, 26 June 2011
Set color for protected screen fields (Screen class)
The ProtectedColor property sets or gets the current default for the color of protected fields in a Screen object. A protected field is assigned this color unless another color value is explicitly specified in the AddField statement that defines the field.
An unprotected field's color can also be changed by the Color method.
Syntax
%currentFieldColor = screen:ProtectedColor screen:ProtectedColor = newFieldColor
Syntax terms
| currentFieldColor | A Fieldcolor enumeration to get the current default color for protected fields. Valid values (case unimportant) are turquoise, green, blue, red, white, yellow, and pink. The default value is blue. |
|---|---|
| screen | A reference to an instance of a Screen object. |
| newFieldColor | A Fieldcolor enumeration to set the new protected field's color. Valid values (case unimportant) are turquoise, green, blue, red, white, yellow, and pink. The default value is blue. |
Examples
- The following statement prints the color of the %scr screen:
print %scr:protectedColor:ToString
See also
- An unprotected field's color can also be changed by the Color method.