Options
From PDF XChange PDF SDK
(Automatic page editing by robot) |
(→Options Table) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
{{#customTitle:Options}} | {{#customTitle:Options}} | ||
{{#parentPage:PXV:op_document_changeInfo|Options|property}} | {{#parentPage:PXV:op_document_changeInfo|Options|property}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| Line 14: | Line 13: | ||
| class="op_param_name" | Flags | | class="op_param_name" | Flags | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies [[PXV:PXV_ChangeDocPropsFlag|flags]] of the properties that should be changed. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Title | | class="op_param_name" | Title | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies document's title. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Author | | class="op_param_name" | Author | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies document's author. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Subject | | class="op_param_name" | Subject | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies document's subject. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Keywords | | class="op_param_name" | Keywords | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies document's keywords. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Creator | | class="op_param_name" | Creator | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies document's creator. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Producer | | class="op_param_name" | Producer | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies document's producer. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | CreatorTool | | class="op_param_name" | CreatorTool | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the program by which the document was created. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | CreationDate | | class="op_param_name" | CreationDate | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies document's creation date. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | ModDate | | class="op_param_name" | ModDate | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies document's modification date. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Trapped | | class="op_param_name" | Trapped | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | 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]]. These should be set like this: |
| + | '''(1 << (int)PXC_DocumentViewFlags.DocViewFlag_DisplayDocTitle)'''; | ||
| + | |||
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]]. | ||
| Line 131: | Line 132: | ||
| class="op_param_name" | PaperByPageSize | | class="op_param_name" | PaperByPageSize | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies whether the document's page size should be used as paper size in printing options. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | PrintRange | | class="op_param_name" | PrintRange | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the default printing pages range. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | NumCopies | | class="op_param_name" | NumCopies | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the default number of copies that should be created when printing the document. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | ActionWillClose | | class="op_param_name" | ActionWillClose | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
| − | | Specifies | + | | Specifies the [[PXV:IPXC_ActionsList|action list]] that will be executed when the document is being closed. |
|- | |- | ||
| class="op_param_name" | ActionWillSave | | class="op_param_name" | ActionWillSave | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
| − | | Specifies | + | | Specifies the [[PXV:IPXC_ActionsList|action list]] that will be executed when the document is being saved. |
|- | |- | ||
| class="op_param_name" | ActionDidSave | | class="op_param_name" | ActionDidSave | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
| − | | Specifies | + | | Specifies the [[PXV:IPXC_ActionsList|action list]] that will be executed after the document was saved. |
|- | |- | ||
| class="op_param_name" | ActionWillPrint | | class="op_param_name" | ActionWillPrint | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
| − | | Specifies | + | | Specifies the [[PXV:IPXC_ActionsList|action list]] that will be executed when the document is being printed. |
|- | |- | ||
| class="op_param_name" | ActionDidPrint | | class="op_param_name" | ActionDidPrint | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
| − | | Specifies | + | | Specifies the [[PXV:IPXC_ActionsList|action list]] that will be executed after the document was printed. |
|- | |- | ||
| class="op_param_name" | Metadata | | class="op_param_name" | Metadata | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
| − | | Specifies | + | | Specifies the document's [[PXV:IPXC_XMPMetadata|metadata]] |
|- | |- | ||
| class="op_param_name" | CustomAdd | | class="op_param_name" | CustomAdd | ||
| style="text-align:center" | Array | | style="text-align:center" | Array | ||
| Array of <tt>'''[[#CustomAdd|Dictionary]]'''</tt> | | Array of <tt>'''[[#CustomAdd|Dictionary]]'''</tt> | ||
| − | Specifies | + | Specifies the custom key list that will be added to the document's metadata. |
|- | |- | ||
| class="op_param_name" | CustomRemove | | class="op_param_name" | CustomRemove | ||
| style="text-align:center" | Array | | style="text-align:center" | Array | ||
| Array of <tt>'''[[#CustomRemove|Dictionary]]'''</tt> | | Array of <tt>'''[[#CustomRemove|Dictionary]]'''</tt> | ||
| − | Specifies | + | Specifies the custom key list that will be removed from the document's metadata. |
|} | |} | ||
| Line 188: | Line 189: | ||
| class="op_param_name" | Key | | class="op_param_name" | Key | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the key's name. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Value | | class="op_param_name" | Value | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the key's value. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|} | |} | ||
| Line 206: | Line 207: | ||
| class="op_param_name" | Key | | class="op_param_name" | Key | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the key name. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|} | |} | ||
Latest revision as of 04:55, 28 October 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. These should be set like this:
(1 << (int)PXC_DocumentViewFlags.DocViewFlag_DisplayDocTitle); 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 whether the document's page size should be used as paper size in printing options.
Default value: -1 |
| PrintRange | String | Specifies the default printing pages range.
Default value: Empty String |
| NumCopies | Integer | Specifies the default number of copies that should be created when printing the document.
Default value: 0 |
| ActionWillClose | IUnknown | Specifies the action list that will be executed when the document is being closed. |
| ActionWillSave | IUnknown | Specifies the action list that will be executed when the document is being saved. |
| ActionDidSave | IUnknown | Specifies the action list that will be executed after the document was saved. |
| ActionWillPrint | IUnknown | Specifies the action list that will be executed when the document is being printed. |
| ActionDidPrint | IUnknown | Specifies the action list that will be executed after the document was printed. |
| Metadata | IUnknown | Specifies the document's metadata |
| CustomAdd | Array | Array of Dictionary
Specifies the custom key list that will be added to the document's metadata. |
| CustomRemove | Array | Array of Dictionary
Specifies the custom key list that will be removed from the document's metadata. |
CustomAdd Table
| Name | Type | Value |
|---|---|---|
| Key | String | Specifies the key's name.
Default value: Empty String |
| Value | String | Specifies the key's value.
Default value: Empty String |
CustomRemove Table
| Name | Type | Value |
|---|---|---|
| Key | String | Specifies the key name.
Default value: Empty String |
