Interface ILibraryQuery

This interface represents a Library search query

Namespace: PSPDFKitFoundation.Search

Assembly: PSPDFKitFoundation.dll

Syntax

public interface ILibraryQuery

Properties

ExcludeAnnotations

Specifies whether the query should exclude annotations.

Declaration

bool ExcludeAnnotations { get; set; }

Property Value

Type	Description
System.Boolean

ExcludeDocumentText

Specifies whether the query should exclude document text search.

Declaration

bool ExcludeDocumentText { get; set; }

Property Value

Type	Description
System.Boolean

GenerateTextPreviews

Set to generate a text preview.

Declaration

bool GenerateTextPreviews { get; set; }

Property Value

Type	Description
System.Boolean

MatchExactPhrases

If the search should only match exact phrases.

Declaration

bool MatchExactPhrases { get; set; }

Property Value

Type	Description
System.Boolean

MatchExactWords

If the search should only match exact words.

Declaration

bool MatchExactWords { get; set; }

Property Value

Type	Description
System.Boolean

MaximumPreviewResultsPerDocument

Specifies the maximum preview results per document.

Declaration

int MaximumPreviewResultsPerDocument { get; set; }

Property Value

Type	Description
System.Int32

MaximumPreviewResultsTotal

Specifies the maximum preview results total.

Declaration

int MaximumPreviewResultsTotal { get; set; }

Property Value

Type	Description
System.Int32

MaximumSearchResultsPerDocument

Specifies the maximum results per document.

Declaration

int MaximumSearchResultsPerDocument { get; set; }

Property Value

Type	Description
System.Int32

MaximumSearchResultsTotal

Specifies the maximum search results returned.

Declaration

int MaximumSearchResultsTotal { get; set; }

Property Value

Type	Description
System.Int32

PreviewRange

Sets the range of the preview that should be generated.

Declaration

Range PreviewRange { get; set; }

Property Value

Type	Description
Range

SearchString

The search string.

Declaration

string SearchString { get; set; }

Property Value

Type	Description
System.String