$HIGHLIGHT_CRITERIA(column [, [length] [,[’options’] [, ‘label’]]])

The $HIGHLIGHT_CRITERIA function is used to retrieve a select item that was also used in the WHERE clause of a SELECT statement, and also highlight all keywords involved in the criteria. If Omnidex Text features such as synonyms, forms and misspellings are used, then the derived words will also be highlighted.

A column or expression to be returned and highlighted.

An optional parameter that controls the length of the string to be returned. If this parameter is not provided, the default size is the length of expression. Note that highlighting increases the space requirements, so length should likely be larger than the normal length of expression.

An optional parameter that controls options for the function. Valid options are:

Render the result in the following style:

TEXT (default)
HTML
NONE

Use HTML classes so that HTML Style Sheets can be used to determine highlighting characteristics.

When used with the CLASSES option, use different classes so that each word can have independent highlighting characteristics.

When used with the CLASSES option, use different classes so that derived words can have independent highlighting characteristics than original words. When used without CLASSES, but with STYLE=HTML, use <st> for original words and <em> for derived words.

HTML tag to use to highlight keywords when STYLE=HTML. Defaults to “<strong>”.

HTML tag to use to end the highlighting of keywords when STYLE=HTML. Defaults to the HIGHLIGHT string with an initial backslash, such as “</strong>”. This option is only needed with more complex HIGHLIGHT strings.

An optional label that describes this particular search. This label is needed when column is found multiple times in the criteria. This label refers to the label used in the $CONTAINS function. The label is case-insensitive, and may be up to 32 characters long.