Options
From PDF XChange PDF SDK
(Test (by SublimeText.Mediawiker)) |
(Label ToWrite removed) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
{{#customTitle:Options}} | {{#customTitle:Options}} | ||
{{#parentPage:PXV:op_document_extractPages|Options|property}} | {{#parentPage:PXV:op_document_extractPages|Options|property}} | ||
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| Line 14: | Line 14: | ||
| class="op_param_name" | [[PXV:cs_PagesRange|PagesRange]] | | class="op_param_name" | [[PXV:cs_PagesRange|PagesRange]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the pages range that will be inserted from the document into the destination. |
|- | |- | ||
| class="op_param_name" | CommentsAction | | class="op_param_name" | CommentsAction | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies what should be done to the annotations on pages. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
| − | | class="op_enum_value" | '''0''' (Copy) || | + | | class="op_enum_value" | '''0''' (Copy) || The annotations will be copied from the original pages into source destination. |
|- | |- | ||
| − | | class="op_enum_value" | '''1''' (Flatten) || | + | | class="op_enum_value" | '''1''' (Flatten) || The annotations will become a part of the original pages' content. |
|- | |- | ||
| − | | class="op_enum_value" | '''2''' (DontCopy) || | + | | class="op_enum_value" | '''2''' (DontCopy) || The annotations won't be copied to the destination. |
|} | |} | ||
Default value: <tt>'''0''' (Copy)</tt> | Default value: <tt>'''0''' (Copy)</tt> | ||
| Line 32: | Line 32: | ||
| class="op_param_name" | FieldsAction | | class="op_param_name" | FieldsAction | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies what should be done to the fields on pages. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
| − | | class="op_enum_value" | '''0''' (Copy) || | + | | class="op_enum_value" | '''0''' (Copy) || The form fields will be copied from the original pages into source destination. |
|- | |- | ||
| − | | class="op_enum_value" | '''1''' (Flatten) || | + | | class="op_enum_value" | '''1''' (Flatten) || The form fields will become a part of the original pages' content. |
|- | |- | ||
| − | | class="op_enum_value" | '''2''' (DontCopy) || | + | | class="op_enum_value" | '''2''' (DontCopy) || The form fields won't be copied to the destination. |
|} | |} | ||
Default value: <tt>'''1''' (Flatten)</tt> | Default value: <tt>'''1''' (Flatten)</tt> | ||
| Line 46: | Line 46: | ||
| class="op_param_name" | BookmarksAction | | class="op_param_name" | BookmarksAction | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the action that would be applied to the bookmarks. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
| − | | class="op_enum_value" | '''0''' (DontCopy) || | + | | class="op_enum_value" | '''0''' (DontCopy) || The bookmarks won't be copied at all. |
|- | |- | ||
| − | | class="op_enum_value" | '''1''' (CopyAll) || . | + | | class="op_enum_value" | '''1''' (CopyAll) || All of the bookmarks will be added to the destination. Bookmarks, that are not related to the current root bookmark, in a new file will not perform any action, - they will be only listed in the Bookmark Pane. |
|- | |- | ||
| − | | class="op_enum_value" | '''2''' (CopyRelated) || | + | | class="op_enum_value" | '''2''' (CopyRelated) || Only the related bookmarks will be copied to the destination document. |
|} | |} | ||
Default value: <tt>'''1''' (CopyAll)</tt> | Default value: <tt>'''1''' (CopyAll)</tt> | ||
| Line 60: | Line 60: | ||
| class="op_param_name" | DeletePages | | class="op_param_name" | DeletePages | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the pages should be deleted from the original document. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | ExtractPagesAction | | class="op_param_name" | ExtractPagesAction | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies how the pages should be extracted. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
| − | | class="op_enum_value" | '''0''' (AllToOneDoc) || | + | | class="op_enum_value" | '''0''' (AllToOneDoc) || The extracted pages will be generated into new document and won't be saved to disk. |
|- | |- | ||
| − | | class="op_enum_value" | '''1''' (AllToOneFile) || | + | | class="op_enum_value" | '''1''' (AllToOneFile) || All of the extracted pages will be saved on disk with specified name. |
|- | |- | ||
| − | | class="op_enum_value" | '''2''' (EachToFile) || | + | | class="op_enum_value" | '''2''' (EachToFile) || Each page will be extracted into separate document. |
|- | |- | ||
| − | | class="op_enum_value" | '''3''' (EachRangeToFile) || | + | | class="op_enum_value" | '''3''' (EachRangeToFile) || The pages will be extracted by page range blocks that were specified in the PagesRange section. |
|} | |} | ||
Default value: <tt>'''1''' (AllToOneFile)</tt> | Default value: <tt>'''1''' (AllToOneFile)</tt> | ||
| Line 81: | Line 81: | ||
| class="op_param_name" | OverwriteAll | | class="op_param_name" | OverwriteAll | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the files on disk with the same name should be automatically overwritten. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | FileName | | class="op_param_name" | FileName | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the file name that should be applied to the new document created from the extracted pages. |
Default value: <tt>'''%[FileName]_%[Page]'''</tt> | Default value: <tt>'''%[FileName]_%[Page]'''</tt> | ||
|- | |- | ||
| class="op_param_name" | LocalFolder | | class="op_param_name" | LocalFolder | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the folder name where the pages will be extracted. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | OpenFolder | | class="op_param_name" | OpenFolder | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the folder, containing the resulting document, created from the extracted pages should be opened. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
|} | |} | ||
Latest revision as of 01:05, 15 March 2016
Options Table
| Name | Type | Value | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| PagesRange | Dictionary | Specifies the pages range that will be inserted from the document into the destination. | ||||||||
| CommentsAction | Integer | Specifies what should be done to the annotations on pages.
Possible values are:
Default value: 0 (Copy) | ||||||||
| FieldsAction | Integer | Specifies what should be done to the fields on pages.
Possible values are:
Default value: 1 (Flatten) | ||||||||
| BookmarksAction | Integer | Specifies the action that would be applied to the bookmarks.
Possible values are:
Default value: 1 (CopyAll) | ||||||||
| DeletePages | Boolean | Specifies whether the pages should be deleted from the original document.
Default value: false | ||||||||
| ExtractPagesAction | Integer | Specifies how the pages should be extracted.
Possible values are:
Default value: 1 (AllToOneFile) | ||||||||
| OverwriteAll | Boolean | Specifies whether the files on disk with the same name should be automatically overwritten.
Default value: false | ||||||||
| FileName | String | Specifies the file name that should be applied to the new document created from the extracted pages.
Default value: %[FileName]_%[Page] | ||||||||
| LocalFolder | String | Specifies the folder name where the pages will be extracted.
Default value: Empty String | ||||||||
| OpenFolder | Boolean | Specifies whether the folder, containing the resulting document, created from the extracted pages should be opened.
Default value: true |
