hiSetFormHighlights

hiSetFormHighlights( 
g_form 
g_highlightType
) 
=> t / nil 

Description

Highlights all type-in fields for form, depending on the value of highlightType.

Highlighting is allowed for type-in fields only, as these are the fields into which invalid data might be entered, or data may be required.

To find type-in fields, the function searches the form or scroll region field specified as r_form. It also does a hierarchical search of all scroll region fields within the form or scroll region field.

Arguments

g_form	Form or scroll region field.
g_highlightType	It can be either a symbol or an integer. As a symbol, it must be error, highlight, or background to set the background color to an error, highlight, or background (default) color, respectively. As an integer, it must be hicError, hicHighlight, or hicBackground.

Values Returned

t	The highlighting flag is set.
nil	The highlighting flag is not set. An error message is displayed.

Related Topics

Form and Field Functions

Return to top