Options
From PDF XChange PDF SDK
(→Options Table) |
|||
| Line 64: | Line 64: | ||
| class="op_param_name" | Trapped | | class="op_param_name" | Trapped | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies document's Trapped atom. | + | | Specifies document's Trapped atom indicating whether the document has been modified to include trapping information. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | PageLayout | | class="op_param_name" | PageLayout | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies [[PXV:PXC_PagesLayout|page layout]] type. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | PageMode | | class="op_param_name" | PageMode | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies [[PXV:PXC_PagesMode|page mode]] type. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | NonFSPageMode | | class="op_param_name" | NonFSPageMode | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies non-full-screen [[PXV:PXC_PagesMode|page mode]] type. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | DestPage | | class="op_param_name" | DestPage | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the page that the document will be opened at for the first time. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | DestZoom | | class="op_param_name" | DestZoom | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the zoom that will be applied to the document when it will be opened. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | DestZoomMode | | class="op_param_name" | DestZoomMode | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the [[PXV:PXV_ZoomMode|zoom mode]] that will be applied to the opened document. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | BaseURL | | class="op_param_name" | BaseURL | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the base URL for web links in the document. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Language | | class="op_param_name" | Language | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies language for reading options in the document. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | R2L | | class="op_param_name" | R2L | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the text should be read from the right to the left. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | ViewFlags | | class="op_param_name" | ViewFlags | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies document's [[PXV:PXC_DocumentViewFlags|view flags]]. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | NoPrintScaling | | class="op_param_name" | NoPrintScaling | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the document should be scaled when printing. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Duplex | | class="op_param_name" | Duplex | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the printing duplex mode. |
The list of possible values are shown in [[PXV:Params_NamedValues_PrintDuplexModes|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_PrintDuplexModes|the table]]. | ||
Revision as of 03:30, 14 March 2016
Options Table
| Name | Type | Value |
|---|---|---|
| Flags | Integer | Specifies flags of the properties that should be changed.
Default value: 0 |
| Title | String | Specifies document's title.
Default value: Empty String |
| Author | String | Specifies document's author.
Default value: Empty String |
| Subject | String | Specifies document's subject.
Default value: Empty String |
| Keywords | String | Specifies document's keywords.
Default value: Empty String |
| Creator | String | Specifies document's creator.
Default value: Empty String |
| Producer | String | Specifies document's producer.
Default value: Empty String |
| CreatorTool | String | Specifies the program by which the document was created.
Default value: Empty String |
| CreationDate | String | Specifies document's creation date.
Default value: Empty String |
| ModDate | String | Specifies document's modification date.
Default value: Empty String |
| Trapped | Integer | Specifies document's Trapped atom indicating whether the document has been modified to include trapping information.
Default value: -1 |
| PageLayout | Integer | Specifies page layout type.
Default value: -1 |
| PageMode | Integer | Specifies page mode type.
Default value: -1 |
| NonFSPageMode | Integer | Specifies non-full-screen page mode type.
Default value: -1 |
| DestPage | Integer | Specifies the page that the document will be opened at for the first time.
Default value: 0 |
| DestZoom | Double | Specifies the zoom that will be applied to the document when it will be opened.
Default value: 0.0 |
| DestZoomMode | Integer | Specifies the zoom mode that will be applied to the opened document.
Default value: 0 |
| BaseURL | String | Specifies the base URL for web links in the document.
Default value: Empty String |
| Language | String | Specifies language for reading options in the document.
Default value: Empty String |
| R2L | Boolean | Specifies whether the text should be read from the right to the left.
Default value: false |
| ViewFlags | Integer | Specifies document's view flags.
Default value: 0 |
| NoPrintScaling | Boolean | Specifies whether the document should be scaled when printing.
Default value: false |
| Duplex | Integer | Specifies the printing duplex mode.
The list of possible values are shown in the table. Default value: 0 (Auto) |
| PaperByPageSize | Integer | Specifies...
Default value: -1 |
| PrintRange | String | Specifies...
Default value: Empty String |
| NumCopies | Integer | Specifies...
Default value: 0 |
| ActionWillClose | IUnknown | Specifies... |
| ActionWillSave | IUnknown | Specifies... |
| ActionDidSave | IUnknown | Specifies... |
| ActionWillPrint | IUnknown | Specifies... |
| ActionDidPrint | IUnknown | Specifies... |
| Metadata | IUnknown | Specifies... |
| CustomAdd | Array | Array of Dictionary
Specifies... |
| CustomRemove | Array | Array of Dictionary
Specifies... |
CustomAdd Table
| Name | Type | Value |
|---|---|---|
| Key | String | Specifies...
Default value: Empty String |
| Value | String | Specifies...
Default value: Empty String |
CustomRemove Table
| Name | Type | Value |
|---|---|---|
| Key | String | Specifies...
Default value: Empty String |
