Options

From PDF XChange PDF SDK
Jump to: navigation, search


Options Table

Name Type Value
Flags Integer Specifies the search flags.

Default value: PXV_SearchFlag_IncludePageText | PXV_SearchFlag_IncludeBookmarks | PXV_SearchFlag_IncludeAnnotations | PXV_SearchFlag_IncludeFormFields | PXV_SearchFlag_LookInSubFolders

Proximity Integer Specifies the search proximity.

Default value: 0

MaxResDocs Integer Specifies maximum number of documents that should be searched through.

Default value: -1

MaxResEntries Integer Specifies maximum number of search entries.

Default value: -1

MaxEmbeddDepth Integer Specifies maximum nesting level of the attachments that will be used for search.

Default value: -1

MaxFolderDepth Integer Specifies maximum folder nesting level.

Default value: -1

StartPage Integer Specifies start page number.

Default value: 0

StopPage Integer Specifies last page number.

Default value: -1

AND Array Array of String

Specifies words that should be found in the combination. The operation will search for text that contains all of these words.

OR Array Array of String

Specifies words that should be found separately or in combination. The operation will search for text that contains any of these words.

NOT Array Array of String

The operation will search for text that contains none of these words.

GetTextOptions IUnknown Specifies the get page text options. When not specified, the default options will be taken.
Progress IUnknown Specifies the custom progress monitor.
Callback IUnknown Specifies the search callback that will be used for acquiring the operations Output.
PageSet IUnknown Specifies the page set that will be used for search. When not specified then the StartPage/StopPage values will be taken into account.