Options
From PDF XChange PDF SDK
| Line 69: | Line 69: | ||
| class="op_param_name" | GetTextOptions | | class="op_param_name" | GetTextOptions | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
| − | | Specifies. | + | | Specifies the [[PXV:IPXC_GetPageTextOptions|get page text options]]. When not specified, the default options will be taken. |
|- | |- | ||
| class="op_param_name" | Progress | | class="op_param_name" | Progress | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
| − | | Specifies | + | | Specifies the custom [[PXV:IProgressMon|progress monitor]]. |
|- | |- | ||
| class="op_param_name" | Callback | | class="op_param_name" | Callback | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
| − | | Specifies | + | | Specifies the [[PXV:IPXV_SearchCallback|search callback]] that will be used for acquiring the operations ''Output''. |
|- | |- | ||
| class="op_param_name" | PageSet | | class="op_param_name" | PageSet | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
| − | | Specifies. | + | | Specifies the page set that will be used for search. When not specified then the StartPage/StopPage values will be taken into account. |
|} | |} | ||
Revision as of 07:05, 20 December 2016
Options Table
| Name | Type | Value |
|---|---|---|
| Flags | Integer | Specifies the search flags.
Default value: -2147483408 |
| 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. |
