Color (ScreenField property): Difference between revisions
Jump to navigation
Jump to search
m (match syntax table to syntax template; edits, tags and links) |
mNo edit summary |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:ScreenField:Color subtitle}} | {{Template:ScreenField:Color subtitle}} | ||
The <var>Color</var> sets or returns the <var>[[#FieldColor enumeration|FieldColor]]</var> | The <var>Color</var> method sets or returns the color value (<var>[[Screen classes#FieldColor enumeration|FieldColor]]</var> enumeration) of a <var>ScreenField</var>. | ||
Colors may be initially set for a field when it is created by the <var>[[ | Colors may be initially set for a field when it is created by the <var>[[AddField_(Screen_function)|AddField]]</var> method. | ||
==Syntax== | ==Syntax== | ||
{{Template:ScreenField:Color syntax}} | {{Template:ScreenField:Color syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th> | <tr><th>%currentFieldcolor</th> | ||
<td>A <var>FieldColor</var> enumeration | <td>A <var>FieldColor</var> enumeration to get <var class="term">sfield</var>'s current color.</td></tr> | ||
<tr><th | |||
<tr><th>sfield</th> | |||
<td>A reference to an instance of a <var>ScreenField</var> object.</td></tr> | <td>A reference to an instance of a <var>ScreenField</var> object.</td></tr> | ||
<tr><th | |||
<td>A <var>FieldColor</var> enumeration | <tr><th>newFieldcolor</th> | ||
<td>A <var>FieldColor</var> enumeration setting the color for the <var class="term">sfield</var>. </td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li> | <ul> | ||
<ul><li> | <li>Under either of these conditions, which are not detectable by the screen methods, the display may not show the intended colors: | ||
<ul><li><var>Color</var> lets you set colors regardless of the actual terminal type, although some terminals may not display these attributes correctly. | |||
<li>Many terminal emulator programs allow local customization of color attributes. | <li>Many terminal emulator programs allow local customization of color attributes. | ||
</ul></ul> | </ul> | ||
<li>Default field colors may be set by the <var>[[ProtectedColor_(Screen_property)|ProtectedColor]]</var> or <var>[[UnprotectedColor_(Screen_property)|UnprotectedColor]]</var> properties. | |||
</ul> | |||
==Examples== | ==Examples== | ||
For an example using <var>Color</var> method calls, see [[Screen object sample code|"Screen object sample code"]]. | |||
==See also== | ==See also== | ||
{{Template:ScreenField:Color footer}} | {{Template:ScreenField:Color footer}} | ||
Latest revision as of 18:05, 20 November 2012
Set or return the FieldColor for a screenfield (ScreenField class)
The Color method sets or returns the color value (FieldColor enumeration) of a ScreenField.
Colors may be initially set for a field when it is created by the AddField method.
Syntax
%currentFieldColor = sfield:Color sfield:Color = newFieldColor
Syntax terms
| %currentFieldcolor | A FieldColor enumeration to get sfield's current color. |
|---|---|
| sfield | A reference to an instance of a ScreenField object. |
| newFieldcolor | A FieldColor enumeration setting the color for the sfield. |
Usage notes
- Under either of these conditions, which are not detectable by the screen methods, the display may not show the intended colors:
- Color lets you set colors regardless of the actual terminal type, although some terminals may not display these attributes correctly.
- Many terminal emulator programs allow local customization of color attributes.
- Default field colors may be set by the ProtectedColor or UnprotectedColor properties.
Examples
For an example using Color method calls, see "Screen object sample code".