hiHighlightField
hiHighlightField(
g_form
s_field
g_highlightType
)
=> t / nil
Description
Highlights a type-in field depending on the value of g_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 the field, this function also searches the scroll region fields within the form or scroll region field specified as r_form. It does a depth-first hierarchical search, which means that scroll region fields within a form or scroll region field are searched before the top level of the form or scroll region field.
Arguments
|
g_form
|
Form returned from hiCreateAppForm or hiCreateForm, or scroll region field returned from hiCreateScrollRegion. Scroll region fields within the form or scroll region field are also searched.
|
|
s_field
|
SKILL field handle representing the field you wish to highlight. The field must be a text-entry (type-in) field only.
|
|
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.
If invalid data has been entered, error color should be specified. Highlight color may be used to indicate required data. To reset the color to the original background color, background color should be used.
|
Values Returned
|
t
|
Highlighting is set.
|
|
nil
|
Highlighting is not set. An error message is also issued.
|
Related Topics
Form and Field Functions
hiCreateAppForm
hiCreateForm
hiCreateScrollRegion
Return to top
