KVHTMLHighlight

This structure defines the search terms that are found and highlighted in the HTML output. It is initialized by calling KVHTMLSetHighlight() and is defined in kvtypes.h. See KVHTMLSetHighlight().

typedef struct tag_KVHTMLHighlight
{
    KVStructHeader;
    char           **ppHLTerms;
    int            nSize;
    KVCharset      eCharset;
    char           *pHLStart;
    char           *pHLEnd;
    BOOL           bMatchCase;
    int            nReserved;
    void           *pReserved;
}
KVHTMLHighlight;

Member Descriptions

KVStructHeader

The KeyView version of the structure. See KVStructHead.

ppHLTerms

An array of terms to be found and highlighted in the HTML output.

nSize

The number of terms to be found and highlighted in the HTML output.

eCharset

The character set of the terms. The available character sets are enumerated in KVCharSet in kvcharset.h. See Convert Character Sets.

pHLStart

The start tag that specifies the text attributes used to highlight the text string.

NOTE: If you output images as SVG, KeyView uses this tag to highlight the terms found in images, so you must make sure that the tag works as expected. In particular, CSS that applies a style to a class does not affect a tag with that class that is inside an SVG.

For example:

<span style="color:#ff0000;background-color:#00FF00;">

pHLEnd

The end tag used to close the highlighting start tag. The end tag for the example above would be </span>

bMatchCase

This Boolean applies only to searches on documents with a target character set of 1252. If this Boolean is set, the text search is case sensitive. By default, the text search is case insensitive.

nReserved

Reserved for future use.

pReserved

Reserved for future use.