Class: SearchResult

ReportViewer.SearchResult

Represents a search result.

example

const result = new SearchResult(0, 'Match', new Rect(0, 0, 10, 10), 0, new Range(0, 5));

Table of contents

Constructors

• constructor

Properties

• DisplayText
• ItemArea
• ItemIndex
• PageIndex
• Range
• UserData
• BeforeBegin
• MakePageStart
• PastEnd

Constructors

constructor

• new SearchResult(pageIndex, displayText, itemArea, itemIndex, range, userData?)

Initializes a new instance of the SearchResult class.

example

const result = new SearchResult(0, 'Match', new Rect(0, 0, 10, 10), 0, new Range(0, 5));

Parameters

Properties

DisplayText

• Readonly DisplayText: string

Gets the text to display for the result.

ItemArea

• Readonly ItemArea: Rect

Gets the coordinates of the matched item area.

ItemIndex

• Readonly ItemIndex: number

Gets the logical page item index.

PageIndex

• Readonly PageIndex: number

Gets the index of the page where the occurrence is found.

Range

• Readonly Range: Range

Gets the selection text range.

UserData

• Optional Readonly UserData: any

Gets optional plugin-specific data.

BeforeBegin

▪ Static Readonly BeforeBegin: SearchResult

Represents a marker indicating the search should begin from the start.

MakePageStart

▪ Static Readonly MakePageStart: (pageIndex: number) => SearchResult

Type declaration

▸ (pageIndex): SearchResult

Represents a marker indicating a page boundary.

Parameters

Returns

SearchResult

PastEnd

▪ Static Readonly PastEnd: SearchResult

Represents a marker indicating the search has passed the end of the document.