Difference between revisions of "Highlight (ScreenField property)"

From m204wiki
Jump to navigation Jump to search
m (unvar)
Line 8: Line 8:
 
===Syntax terms===
 
===Syntax terms===
 
<table class="syntaxTable">
 
<table class="syntaxTable">
<tr><th><var>currentHightlight</var></th>
+
<tr><th>%currentHightlight</th>
 
<td>An enumeration of type <var>Highlight</var> (see below) to get <var class="term">sField</var>'s current hightlight.</td></tr>
 
<td>An enumeration of type <var>Highlight</var> (see below) to get <var class="term">sField</var>'s current hightlight.</td></tr>
<tr><th><var>sfield</var></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><var>newHightlight</var></th>
+
<tr><th>newHightlight</th>
 
<td>An enumeration of type <var>Highlight</var> (see below) setting <var class="term">sField</var>'s new hightlight.</td></tr>
 
<td>An enumeration of type <var>Highlight</var> (see below) setting <var class="term">sField</var>'s new hightlight.</td></tr>
 
</table>
 
</table>

Revision as of 10:42, 28 June 2011

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.

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