Difference between revisions of "Highlight (ScreenField property)"

From m204wiki
Jump to navigation Jump to search
 
(3 intermediate revisions by 2 users not shown)
Line 6: Line 6:
 
==Syntax==
 
==Syntax==
 
{{Template:ScreenField:Highlight syntax}}
 
{{Template:ScreenField:Highlight syntax}}
 +
 
===Syntax terms===
 
===Syntax terms===
 
<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>
<tr><th>newHightlight</th>
+
<tr><th>newHighlight</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>
 
===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==
<ul><li>  Under either of these conditions, which are not detectable by the screen methods, the display may not show the intended colors:
+
<ul>
<ul><li><var>Highlight</var> lets you set highlights regardless of the actual terminal type, although some terminals may not display these attributes correctly.
+
<li>  Under either of these conditions, which are not detectable by the screen methods, the display may not show the intended colors:
 +
<ul>
 +
<li><var>Highlight</var> lets you set highlights regardless of the actual terminal type, although some terminals may not display these attributes correctly.
 
<li>Many terminal emulator programs allow local customization of highlighting attributes.
 
<li>Many terminal emulator programs allow local customization of highlighting attributes.
</ul></ul>
+
</ul>
 +
 
 +
<li>Default field highlights may be set by the <var>[[ProtectedHighlight_(Screen_property)|ProtectedHighlight]]</var> or <var>[[UnprotectedHighlight_(Screen_property)|UnprotectedHighlight]]</var> properties.
 +
</ul>
  
 
==Examples==
 
==Examples==
Line 31: Line 32:
  
 
==See also==
 
==See also==
<ul><li>Default field highlights may be set by the <var>[[ProtectedHighlight_(Screen_property)|ProtectedHighlight]]</var> or <var>[[UnprotectedHighlight_(Screen_property)|UnprotectedHighlight]]</var> properties.
 
</ul>
 
 
{{Template:ScreenField:Highlight footer}}
 
{{Template:ScreenField:Highlight footer}}

Latest revision as of 18:06, 20 November 2012

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.
newHighlight 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.
  • Default field highlights may be set by the ProtectedHighlight or UnprotectedHighlight properties.

Examples

For an example using Highlight method calls, see "Screen object sample code".

See also