Difference between revisions of "Highlight (ScreenField property)"

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m
Line 1: Line 1:
 
{{Template:ScreenField:Highlight subtitle}}
 
{{Template:ScreenField:Highlight subtitle}}
  
This property sets or returns the value of the highlight for a ScreenField. This value is a ScreenField class enumeration. This attribute is initially set for a field by the [[Screen class#AddField function|AddField method]].
+
The <var>[[#Highlight enumeration|Highlight]]</var> enumeration provides the highlight value. This attribute is initially set for a field by the [[Screen class#AddField function|AddField method]].
 
==Syntax==
 
==Syntax==
 
{{Template:ScreenField:Highlight syntax}}
 
{{Template:ScreenField:Highlight syntax}}
Line 7: Line 7:
 
<table class="syntaxTable">
 
<table class="syntaxTable">
 
<tr><th>value</th>
 
<tr><th>value</th>
<td>An enumeration of type Highlight. Valid values are none, underline, reverse, and blink. The default value is none. </td></tr>
+
<td>An enumeration of type <var>Highlight</var> (se 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>
 +
===Highlight enumeration===
 +
Valid values of this enumeration are <var>None</var>, <var>Underline</var>, <var>Reverse</var>, and <var>Blink</var>. The default value is <var>None</var>.
  
 
==Usage notes==
 
==Usage notes==
 
 
The Highlight method lets you set highlights regardless of the actual terminal type, although some terminals may not display these attributes correctly. Also, many terminal emulator programs allow local customization of highlighting attributes. Under either of these conditions, which are not detectable by the Screen methods, the actual display may not show the intended highlighting.
 
The Highlight method lets you set highlights regardless of the actual terminal type, although some terminals may not display these attributes correctly. Also, many terminal emulator programs allow local customization of highlighting attributes. Under either of these conditions, which are not detectable by the Screen methods, the actual display may not show the intended highlighting.
  

Revision as of 15:46, 17 May 2011

Set or return the highlight attribute for screenfield (ScreenField class)


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

value An enumeration of type Highlight (se below).
%sfield A reference to an instance of a ScreenField object.

Highlight enumeration

Valid values of this enumeration are None, Underline, Reverse, and Blink. The default value is None.

Usage notes

The Highlight method lets you set highlights regardless of the actual terminal type, although some terminals may not display these attributes correctly. Also, many terminal emulator programs allow local customization of highlighting attributes. Under either of these conditions, which are not detectable by the Screen methods, the actual display may not show the intended highlighting.

For an example using Highlight method calls, see &#x201C;Screen class example&#x201D;.

See also