ITextSearchResultOptions | Colibrio Reader Framework API

Options object controlling the data available in search result items

Hierarchy

ITextSearchResultOptions

Index

Properties

Optional expandMode

This option controls how the text in SearchResultItem.textBefore and the SearchResultItem.textAfter is computed. This property is related to the options numberOfCharactersAfter and numberOfCharactersBefore

See TextSearchResultExpandMode for available modes.

default: EXPAND_TO_WORD_BOUNDARY

Optional includeContentBlocks

includeContentBlocks?: boolean

If set to true, the ContentBlocks that contain the matching text are included in the SearchResultItem.

nativeignore

Optional numberOfCharactersAfter

numberOfCharactersAfter?: number

Number of UTF-16/UCS-2 char codes after the match that should be included in the textAfter property in SearchResultItems.

The actual number of characters included depends on which expandMode that is used. Please see TextSearchResultExpandMode for more details.

int
default: 40

Optional numberOfCharactersBefore

numberOfCharactersBefore?: number

Number of UTF-16/UCS-2 char codes before the match that should be included in the textBefore property in SearchResultItems.

The actual number of characters included depends on which expandMode that is used. Please see TextSearchResultExpandMode for more details.

int
default: 40