Class LibraryQuery

This class represents a search query that can be performed on a Library

Inheritance
System.Object
LibraryQuery
Implements
Namespace: PSPDFKit.Search
Assembly: PSPDFKit.dll
Syntax
public sealed class LibraryQuery : object, ILibraryQuery

Constructors

LibraryQuery(String)

Constructs a library query.

Declaration
public LibraryQuery(string searchTerm)
Parameters
Type Name Description
System.String searchTerm

Properties

DefaultMaximumSearchResults

The default maximum search results to be found before the search is stopped.

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

ExcludeAnnotations

Specifies whether the query should exclude annotations.

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

ExcludeDocumentText

Specifies whether the query should exclude document text search.

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

GenerateTextPreviews

Set to generate a text preview.

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

MatchExactPhrases

If the search should only match exact phrases.

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

MatchExactWords

If the search should only match exact words.

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

MaximumPreviewResultsPerDocument

Specifies the maximum preview results per document.

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

MaximumPreviewResultsTotal

Specifies the maximum preview results total.

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

MaximumSearchResultsPerDocument

Specifies the maximum results per document.

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

MaximumSearchResultsTotal

Specifies the maximum search results returned.

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

PreviewRange

Sets the range of the preview that should be generated.

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

SearchString

The search string.

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

Implements

ILibraryQuery