Difference between revisions of "Highlight (ScreenField property)"

From m204wiki
Jump to navigation Jump to search
m
Line 9: Line 9:
 
<table class="syntaxTable">
 
<table class="syntaxTable">
 
<tr><th>%currentHightlight</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>[[Screen classes#Highlight enumeration|Highlight]]</var> to get <var class="term">sField</var>'s current hightlight.</td></tr>
 
<tr><th>sfield</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>
Line 15: Line 15:
 
<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>
 
===Highlight enumeration===
 
Valid values of this [[Enumerations|enumeration]] are <var>None</var>, <var>Underline</var>, <var>Reverse</var>, and <var>Blink</var>. The default value is <var>None</var>.
 
 
'''Note:''' As with all enumerations, the <var>ToString</var> 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 [[Enumerations#Common enumeration methods|"Common enumeration methods"]].
 
  
 
==Usage notes==
 
==Usage notes==

Revision as of 02:03, 17 August 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 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.

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