KeyView 24.1

# Search and Highlight Terms

KeyView can use the highlighting API to find and highlight specified text strings in the HTML output. Only text strings that exactly match the search term are highlighted. For example, if you specify the term house, the string house is highlighted in house, houses, and housed, but is not highlighted in the term housing. You can define the text attributes used to highlight the text, such as bold, red, or underlined, and the text's target character set.

If a specified term contains HTML code, it is not found. For example, if the phrase weekly schedule was specified, the following string in the output HTML would not be found:

    weekly <b>schedule</b>

If you specify multiple terms, and some terms are subsets of other terms, OpenText recommends that you specify the superset first. For example,

    ["North American car manufacturers" "car manufacturers" "car"]

To specify search terms by using the C API

1. Define the `KVHTMLHighlight` data structure specifying the list of terms, the highlighting attributes, and the case-sensitivity Boolean. See KVHTMLHighlight.

2. Call the `fpSetHighlight()` function. See KVHTMLSetHighlight().

Copyright 1997-2023 Open Text
Version 24.1 | Last updated December 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.1

Topic Title: Search and Highlight Terms