Highlight (ScreenField property): Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{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]]. | 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]]. | ||
==Syntax== | ==Syntax== | ||
{{Template:ScreenField:Highlight syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<dl> | <dl> | ||
| Line 9: | Line 12: | ||
</dl> | </dl> | ||
==Usage | ==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. | ||
For an example using Highlight method calls, see | For an example using Highlight method calls, see “[[Screen class example]]”. | ||
==See also== | |||
{{Template:ScreenField:Highlight footer}} | |||
Revision as of 20:18, 18 March 2011
Set or return the highlight attribute for screenfield (ScreenField class)
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 AddField method.
Syntax
%currentHighlight = sfield:Highlight sfield:Highlight = newHighlight
Syntax terms
- value
- An enumeration of type Highlight. Valid values are none, underline, reverse, and blink. The default value is none.
- %sfield
- A reference to an instance of a ScreenField object.
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 “Screen class example”.