Interface IQuery

This interface represents a search query

Namespace: PSPDFKitFoundation.Search
Assembly: PSPDFKitFoundation.dll
Syntax
public interface IQuery

Properties

CompareOptions

Declaration
CompareOptions CompareOptions { get; set; }
Property Value
Type Description
CompareOptions

GenerateTextPreviews

Set to generate a text preview. Default is true.

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

MaximumSearchResults

Specifies the maximum search results returned.

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

PreviewRange

Sets the range of the preview that should be generated.

Declaration
IRange PreviewRange { get; set; }
Property Value
Type Description
IRange

PriorityPages

Search the pages in this list of IRanges first. Each IRange specifies a starting page index and a length.

Declaration
IList<IRange> PriorityPages { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<IRange>

ReturnEmptyResults

Set to true to return an empty result set for pages with no matches.

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

SearchAllPages

Set to specify whether all pages should be searched.

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

SearchAnnotations

Set to search the content of annotations.

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

SearchTerm

The search term string.

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