Highlight (ScreenField property) - Revision history

JAL: /* Syntax terms */

2012-11-20T18:06:16Z

Syntax terms

← Older revision		Revision as of 18:06, 20 November 2012
Line 10:		Line 10:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%currentHightlight</th>		<tr><th>%currentHightlight</th>
	<td>An enumeration of type <var>[[Screen classes#Highlight enumeration\|Highlight]]</var> 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>

JAL: /* Syntax terms */

2012-11-20T18:04:38Z

Syntax terms

← Older revision		Revision as of 18:04, 20 November 2012
Line 13:		Line 13:
	<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>

JAL at 18:04, 20 November 2012

2012-11-20T18:04:18Z

← Older revision		Revision as of 18:04, 20 November 2012
Line 6:		Line 6:
	==Syntax==		==Syntax==
	{{Template:ScreenField:Highlight syntax}}		{{Template:ScreenField:Highlight syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 13:		Line 14:
	<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>newHightlight</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>

	==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 26:		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}}

JAL2 at 02:03, 17 August 2011

2011-08-17T02:03:05Z

← Older revision		Revision as of 02:03, 17 August 2011
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==

JAL2: /* Highlight enumeration */

2011-08-16T21:08:13Z

Highlight enumeration

← Older revision		Revision as of 21:08, 16 August 2011
Line 17:		Line 17:

	===Highlight enumeration===		===Highlight enumeration===
	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~~>.		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==

Goff: unvar

2011-06-28T10:42:16Z

unvar

← Older revision		Revision as of 10:42, 28 June 2011
Line 8:		Line 8:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>~~<var>~~currentHightlight~~</var>~~</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>Highlight</var> (see below) to get <var class="term">sField</var>'s current hightlight.</td></tr>
	<tr><th~~><var~~>sfield~~</var>~~</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~~><var~~>newHightlight~~</var>~~</th>		<tr><th>newHightlight</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>

JAL2: /* Examples */

2011-06-27T22:42:26Z

Examples

← Older revision		Revision as of 22:42, 27 June 2011
Line 26:		Line 26:

	==Examples==		==Examples==
	~~<ol><Li>~~For an example using <var>Highlight</var> method calls, see [[Screen ~~Object Sample Code~~\|"Screen ~~Object Sample Code~~"]].		For an example using <var>Highlight</var> method calls, see [[Screen object sample code\|"Screen object sample code"]].
	~~</ol>~~

	==See also==		==See also==

Goff: match syntax table to syntax template; edits, tags and links

2011-06-26T08:20:26Z

match syntax table to syntax template; edits, tags and links

← Older revision		Revision as of 08:20, 26 June 2011
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.

	~~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}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>~~value~~</th>		<tr><th><var>currentHightlight</var></th>
	<td>An enumeration of type <var>Highlight</var> (se below). </td></tr>		<td>An enumeration of type <var>Highlight</var> (see below) to get <var class="term">sField</var>'s current hightlight.</td></tr>
	<tr><th>%sfield</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 <~~var~~>None</~~var~~>, <~~var~~>Underline</~~var~~>, <~~var~~>Reverse</~~var~~>, and <~~var~~>Blink</~~var~~>. The default value is <~~var~~>None</~~var~~>.		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==
	~~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~~.		<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>

	~~For an example using Highlight method calls, see &#x201C;[[Screen class example]]&#x201D;.~~
	==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}}

JAL2 at 15:46, 17 May 2011

2011-05-17T15:46:09Z

← Older revision		Revision as of 15:46, 17 May 2011
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.

TomWiccan: 1 revision

2011-03-18T20:18:41Z

1 revision

← Older revision	Revision as of 20:18, 18 March 2011
(No difference)