Class LibraryPreviewResult

Represents a search result and it's preview text. Also indicates what document and page it was found in and whether it was in an annotation or not.

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

Properties

AnnotationId

The Annotation ID, if the preview is for an annotation. Set to -1 for document text previews.

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

PageIndex

The Page Index where the result was found.

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

PreviewText

The preview text.

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

RangeInPreviewText

The range in the preview text of the search term.

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

RangeInText

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

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

Uid

The UID of the document.

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