Action disabled: source

DRAFT

$HIGHLIGHT_KEYWORDS

$HIGHLIGHT_KEYWORDS (column, keywords, [, [length] [,[’options’]]])

The $HIGHLIGHT_KEYWORDS function is used to retrieve a select item and highlight specific keywords. Unlike $CONTEXT and $HIGHLIGHT_CRITERIA, the $HIGHLIGHT If Omnidex Text features such as synonyms, forms and misspellings are used, then the derived words will also be highlighted.

column

A column or expression to be returned and highlighted.

keywords

A string or expression containing the keywords to be highlighted.

length

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.

options

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

STYLE=

Render the result in the following style:

TEXT (default)
HTML
NONE
CLASSES

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

DISTINGUISH_WORDS

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

HIGHLIGHT=”string”

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

END_HIGHLIGHT=”string”

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.

 
Back to top
dev/sql/functions/highlight_keywords/home.txt · Last modified: 2016/06/28 22:38 (external edit)