Options
From PDF XChange PDF SDK
(Automatic page editing by robot) |
(→Options Table) |
||
(9 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
{{#customTitle:Options}} | {{#customTitle:Options}} | ||
{{#parentPage:PXV:op_document_replacePages|Options|property}} | {{#parentPage:PXV:op_document_replacePages|Options|property}} | ||
− | |||
{{ToReview}} | {{ToReview}} | ||
Line 14: | Line 13: | ||
| 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" | Position | | class="op_param_name" | Position | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the pages start index to which the replace should be applied to. |
− | Default value: <tt>''' | + | Default value: <tt>'''0'''</tt> |
|- | |- | ||
| 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. To use this the '''ContentOnly''' flag needs to be '''false'''. |
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 37: | Line 36: | ||
| 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. To use this the '''ContentOnly''' flag needs to be '''false'''. |
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) || The form fields will become a part of the original pages' content. | ||
|- | |- | ||
− | | class="op_enum_value" | ''' | + | | class="op_enum_value" | '''2''' (DontCopy) || The form fields won't be copied to the destination. |
|- | |- | ||
− | | class="op_enum_value" | ''' | + | | class="op_enum_value" | '''3''' (CopyWithRename) || The form fields will be copied and renamed automatically to unique names if needed. |
|} | |} | ||
Default value: <tt>'''1''' (Flatten)</tt> | Default value: <tt>'''1''' (Flatten)</tt> | ||
Line 51: | Line 52: | ||
| 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. To use this the '''ContentOnly''' flag needs to be '''false'''. |
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 65: | Line 66: | ||
| class="op_param_name" | LastSrcMode | | class="op_param_name" | LastSrcMode | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the last selected source mode on dialog. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
− | | class="op_enum_value" | '''0''' (FromFile) || | + | | class="op_enum_value" | '''0''' (FromFile) || The data will be taken from the '''LastSrcFile''' param. |
|- | |- | ||
− | | class="op_enum_value" | '''1''' (FromOpenedDoc) || | + | | class="op_enum_value" | '''1''' (FromOpenedDoc) || The data will be taken from the '''LastSrcDoc''' param. |
|} | |} | ||
Default value: <tt>'''1''' (FromOpenedDoc)</tt> | Default value: <tt>'''1''' (FromOpenedDoc)</tt> | ||
Line 77: | Line 78: | ||
| class="op_param_name" | LastSrcFile | | class="op_param_name" | LastSrcFile | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
− | | Specifies | + | | Specifies the path to the file. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | LastSrcDoc | | class="op_param_name" | LastSrcDoc | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
− | | Specifies | + | | Specifies the path to the document. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | PositionStop | | class="op_param_name" | PositionStop | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the pages stop index to which the replace should be applied to. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | ContentOnly | | class="op_param_name" | ContentOnly | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
− | | Specifies | + | | Specifies that only content (text and images which are the part of content) of selected pages from an active document will be replaced with content of new pages. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Src | | class="op_param_name" | Src | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
− | | Specifies | + | | Specifies the source data ([[PXV:IAFS_Name|IAFS_Name]], [[PXV:IAFS_File|IAFS_File]]). |
|} | |} |
Latest revision as of 07:03, 10 May 2019
Options Table
Name | Type | Value | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
PagesRange | Dictionary | Specifies the pages range that will be inserted from the document into the destination. | ||||||||
Position | Integer | Specifies the pages start index to which the replace should be applied to.
Default value: 0 | ||||||||
CommentsAction | Integer | Specifies what should be done to the annotations on pages. To use this the ContentOnly flag needs to be false.
Possible values are:
Default value: 0 (Copy) | ||||||||
FieldsAction | Integer | Specifies what should be done to the fields on pages. To use this the ContentOnly flag needs to be false.
Possible values are:
Default value: 1 (Flatten) | ||||||||
BookmarksAction | Integer | Specifies the action that would be applied to the bookmarks. To use this the ContentOnly flag needs to be false.
Possible values are:
Default value: 1 (CopyAll) | ||||||||
LastSrcMode | Integer | Specifies the last selected source mode on dialog.
Possible values are:
Default value: 1 (FromOpenedDoc) | ||||||||
LastSrcFile | String | Specifies the path to the file.
Default value: Empty String | ||||||||
LastSrcDoc | String | Specifies the path to the document.
Default value: Empty String | ||||||||
PositionStop | Integer | Specifies the pages stop index to which the replace should be applied to.
Default value: -1 | ||||||||
ContentOnly | Boolean | Specifies that only content (text and images which are the part of content) of selected pages from an active document will be replaced with content of new pages.
Default value: true | ||||||||
Src | IUnknown | Specifies the source data (IAFS_Name, IAFS_File). |