Namespace PSPDFKitFoundation.Search

Classes

LibraryIndexingSuccess

Represents success or failure of the indexing of a document.

LibraryIndexStatus

Represents the index status of a document and it's index progress if it's currently being indexed.

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.

LibraryQueryResult

Represents the list of pages with a specific document where the query matched some text.

PageIndexed

Represents a page indexed event result.

PageResults

Represents the query results for one page.

Result

A class representing a search result.

Interfaces

ILibraryQuery

This interface represents a Library search query

IQuery

This interface represents a search query

Enums

CompareOptions

These flags are used to specify the search options.

IndexDocumentStatus

Represents the index status of a document.

SearchPattern

This enum exposes built-in patterns for finding common strings for search operations.

Note that by design, some of these patterns might overfit the criteria (i.e. include false positive results). This might happen since we strive for including all positive results and avoid data loss. Make sure to review the matches found.

SearchType

Search type used when matching content to the desired term, regular expression, or preset.