Class Result

A class representing a search result.

Inheritance
System.Object
Result
Namespace: PSPDFKitFoundation.Search
Assembly: PSPDFKitFoundation.dll
Syntax
public sealed class Result : object

Constructors

Result(Int32, Range, String, Range, Boolean, IEnumerable<Rect>)

Construct a Result.

Declaration
public Result(int pageIndex, Range rangeInText, string previewText, Range rangeInPreviewText, bool isAnnotation, IEnumerable<Rect> rects)
Parameters
Type Name Description
System.Int32 pageIndex

The index of the page that contains the preview result.

Range rangeInText

The range of the search hit in the page text or annotation text of the given document.

System.String previewText

The preview text.

Range rangeInPreviewText

The range in the preview text of the search term.

System.Boolean isAnnotation

Denotes if the text was found in an annotation.

IEnumerable<Rect> rects

The rects on the page bounding the matching text.

Properties

IsAnnotation

Is this in an annotation.

Declaration
public bool IsAnnotation { get; }
Property Value
Type Description
System.Boolean

PageIndex

The index of the page that contains the preview result.

Declaration
public int PageIndex { get; }
Property Value
Type Description
System.Int32

PreviewText

The preview text.

Declaration
public string PreviewText { get; }
Property Value
Type Description
System.String

RangeInPreviewText

The range in the preview text of the search term.

Declaration
public Range RangeInPreviewText { get; }
Property Value
Type Description
Range

RangeInText

The range of the search hit in the page text or annotation text of the given document.

Declaration
public Range RangeInText { get; }
Property Value
Type Description
Range

Rects

The rects on the page bounding the matching text.

Declaration
public IEnumerable<Rect> Rects { get; }
Property Value
Type Description
IEnumerable<Rect>