Highlight (ScreenField property)
Set or return the highlight attribute for screenfield (ScreenField class)
The Highlight property sets or returns the value of the highlight for a ScreenField. The Highlight enumeration provides the highlight value.
This attribute is initially set for a field by the AddField method.
Syntax
%currentHighlight = sfield:Highlight sfield:Highlight = newHighlight
Syntax terms
| %currentHightlight | An enumeration of type Highlight (see below) to get sField's current hightlight. |
|---|---|
| sfield | A reference to an instance of a ScreenField object. |
| newHightlight | An enumeration of type Highlight (see below) setting sField's new hightlight. |
Highlight enumeration
Valid values of this enumeration are None, Underline, Reverse, and Blink. The default value is None.
Note: As with all enumerations, the ToString method implicitly converts an enumeration value to a character string whose value is the name of the enumeration value. For more information about methods available to all enumerations, see "Common enumeration methods".
Usage notes
- Under either of these conditions, which are not detectable by the screen methods, the display may not show the intended colors:
- Highlight lets you set highlights regardless of the actual terminal type, although some terminals may not display these attributes correctly.
- Many terminal emulator programs allow local customization of highlighting attributes.
Examples
For an example using Highlight method calls, see "Screen object sample code".
See also
- Default field highlights may be set by the ProtectedHighlight or UnprotectedHighlight properties.