Color (ScreenField property): Difference between revisions
m (→Syntax terms) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:ScreenField:Color subtitle}} | {{Template:ScreenField:Color subtitle}} | ||
The <var>[[#FieldColor enumeration|FieldColor]]</var> enumeration provides the color value. This attribute is initially set for a field by the [[Screen class#AddField function|AddField method]]. | |||
==Syntax== | ==Syntax== | ||
{{Template:ScreenField:Color syntax}} | {{Template:ScreenField:Color syntax}} | ||
| Line 7: | Line 7: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>fieldcolor</th> | <tr><th>fieldcolor</th> | ||
<td>A FieldColor enumeration | <td>A FieldColor enumeration (see below). </td></tr> | ||
<tr><th>%sfield</th> | <tr><th>%sfield</th> | ||
<td>A reference to an instance of a ScreenField object.</td></tr> | <td>A reference to an instance of a ScreenField object.</td></tr> | ||
</table> | </table> | ||
===FieldColor enumeration=== | |||
The valid values (case unimportant) of this enumeration are turquoise, green, blue, red, white, yellow, and pink. The default is blue. | |||
==Usage notes== | ==Usage notes== | ||
Revision as of 15:32, 17 May 2011
Set or return the FieldColor for a screenfield (ScreenField class)
The FieldColor enumeration provides the color value. This attribute is initially set for a field by the AddField method.
Syntax
%currentFieldColor = sfield:Color sfield:Color = newFieldColor
Syntax terms
| fieldcolor | A FieldColor enumeration (see below). |
|---|---|
| %sfield | A reference to an instance of a ScreenField object. |
FieldColor enumeration
The valid values (case unimportant) of this enumeration are turquoise, green, blue, red, white, yellow, and pink. The default is blue.
Usage notes
The Color property lets you set colors regardless of the actual terminal type, although some terminals may not display these attributes correctly. Also, many terminal emulator programs allow local customization of color attributes. Under either of these conditions, which are not detectable by the screen methods, the display may not show the intended colors.
For an example using Color method calls, see “Screen class example”.