# ReportViewer.SearchResult

## Content

# Class: SearchResult

[ReportViewer](../modules/ReportViewer).SearchResult

Defines a search result.

## Table of contents

### Properties

- [DisplayText](ReportViewer.SearchResult#displaytext)
- [ItemArea](ReportViewer.SearchResult#itemarea)
- [ItemIndex](ReportViewer.SearchResult#itemindex)
- [PageIndex](ReportViewer.SearchResult#pageindex)
- [Range](ReportViewer.SearchResult#range)
- [UserData](ReportViewer.SearchResult#userdata)
- [BeforeBegin](ReportViewer.SearchResult#beforebegin)
- [PastEnd](ReportViewer.SearchResult#pastend)

## Properties

### <a id="displaytext" name="displaytext"></a> DisplayText

• `Readonly` **DisplayText**: `string`

Text to display.

___

### <a id="itemarea" name="itemarea"></a> ItemArea

• `Readonly` **ItemArea**: [`Rect`](ReportViewer.Rect)

The whole text item area coordinates.

___

### <a id="itemindex" name="itemindex"></a> ItemIndex

• `Readonly` **ItemIndex**: `number`

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

___

### <a id="pageindex" name="pageindex"></a> PageIndex

• `Readonly` **PageIndex**: `number`

The index of the page where the occurence is found.

___

### <a id="range" name="range"></a> Range

• `Readonly` **Range**: [`Range`](ReportViewer.Range)

The selection text range.

___

### <a id="userdata" name="userdata"></a> UserData

• `Optional` `Readonly` **UserData**: `any`

Plugin-specific data.

___

### <a id="beforebegin" name="beforebegin"></a> BeforeBegin

▪ `Static` `Readonly` **BeforeBegin**: [`SearchResult`](ReportViewer.SearchResult)

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

___

### <a id="pastend" name="pastend"></a> PastEnd

▪ `Static` `Readonly` **PastEnd**: [`SearchResult`](ReportViewer.SearchResult)

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