Difference between revisions of "Highlight (ScreenField property)"
Jump to navigation
Jump to search
m |
m (match syntax table to syntax template; edits, tags and links) |
||
| Line 1: | Line 1: | ||
{{Template:ScreenField:Highlight subtitle}} | {{Template:ScreenField:Highlight subtitle}} | ||
| + | The <var>Highlight</var> property sets or returns the value of the highlight for a <var>ScreenField</var>. The <var>[[#Highlight enumeration|Highlight]]</var> enumeration provides the highlight value. | ||
| + | |||
| + | This attribute is initially set for a field by the <var>[[AddField_(Screen_function)|AddField]]</var> method. | ||
| − | |||
==Syntax== | ==Syntax== | ||
{{Template:ScreenField:Highlight syntax}} | {{Template:ScreenField:Highlight syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
| − | <tr><th> | + | <tr><th><var>currentHightlight</var></th> |
| − | <td>An enumeration of type <var>Highlight</var> ( | + | <td>An enumeration of type <var>Highlight</var> (see below) to get <var class="term">sField</var>'s current hightlight.</td></tr> |
| − | <tr><th> | + | <tr><th><var>sfield</var></th> |
| − | <td>A reference to an instance of a ScreenField object.</td></tr> | + | <td>A reference to an instance of a <var>ScreenField</var> object.</td></tr> |
| + | <tr><th><var>newHightlight</var></th> | ||
| + | <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=== | ===Highlight enumeration=== | ||
| − | Valid values of this enumeration are < | + | Valid values of this enumeration are <code>None</code>, <code>Underline</code>, <code>Reverse</code>, and <code>Blink</code>. The default value is <code>None</code>. |
==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><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. | ||
| + | </ul></ul> | ||
| + | |||
| + | ==Examples== | ||
| + | <ol><Li>For an example using <var>Highlight</var> method calls, see [[Screen Object Sample Code|"Screen Object Sample Code"]]. | ||
| + | </ol> | ||
| − | |||
==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}} | ||
Revision as of 08:20, 26 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
- Default field highlights may be set by the ProtectedHighlight or UnprotectedHighlight properties.