V1
SearchResult ActiveReportsJS Class

SearchResult Class

Defines a search result.

Hierarchy

  • SearchResult

Properties

DisplayText

DisplayText: string

Text to display.

ItemArea

ItemArea: Rect

The whole text item area coordinates.

ItemIndex

ItemIndex: number

The logical page item number (for subsequent searches, ordered).

PageIndex

PageIndex: number

The index of the page where the occurence is found.

Range

Range: Range

The selection text range.

Optional UserData

UserData: any

Plugin-specific data.

Static BeforeBegin

BeforeBegin: SearchResult

Special result value for Find method to begin searching from the beginning of the document/page

Static PastEnd

PastEnd: SearchResult

Result indicating search is finished. Also indicates position past the end of document.