# Search.SearchResult

## Content

# Class: SearchResult

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

Defines a search result.

## Table of contents

### Properties

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

## Properties

### DisplayText

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

Text to display.

#### Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1580

___

### ItemArea

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

The whole text item area coordinates.

#### Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1582

___

### ItemIndex

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

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

#### Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1584

___

### PageIndex

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

The index of the page where the occurence is found.

#### Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1578

___

### Range

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

The selection text range.

#### Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1586

___

### UserData

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

Plugin-specific data.

#### Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1588

___

### BeforeBegin

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

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

#### Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1608

___

### PastEnd

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

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

#### Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:1606