Options

From PDF XChange PDF SDK
Jump to: navigation, search
(→‎Options Table)
 
(7 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{#customTitle:Options}}
 
{{#customTitle:Options}}
 
{{#parentPage:PXV:op_document_insertPages|Options|property}}
 
{{#parentPage:PXV:op_document_insertPages|Options|property}}
−
{{ToWrite}}
+
 
 
{{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 the pages range that will be page insert from the document.
+
| 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 the pages start index which the insert should be applied to.
+
| Specifies the position where the pages will be inserted.
 
Default value: <tt>'''-1'''</tt>
 
Default value: <tt>'''-1'''</tt>
 
|-
 
|-
 
| class="op_param_name" | CommentsAction
 
| class="op_param_name" | CommentsAction
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
−
| Specifies the action which the comments should be applied to..
+
| 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) || The add related comments to the new documents as Comments.
+
| class="op_enum_value" | '''0''' (Copy) || The annotations will be copied from the original pages into source destination.
 
|-
 
|-
−
| class="op_enum_value" | '''1''' (Flatten) || The add these comments as part of the documents content - Flatten Comments.
+
| class="op_enum_value" | '''1''' (Flatten) || The annotations will become a part of the original pages' content.
 
|-
 
|-
−
| class="op_enum_value" | '''2''' (DontCopy) || Discard all comment will result in documents without comments.
+
| 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 37:
 
| class="op_param_name" | FieldsAction
 
| class="op_param_name" | FieldsAction
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
−
| Specifies the action which the form field should be applied to.
+
| 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) || The copy all form field.
+
| 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 add the content of form fields to the resulting documents' content.
+
| class="op_enum_value" | '''1''' (Flatten) || The form fields will become a part of the original pages' content.
 
|-
 
|-
−
| class="op_enum_value" | '''2''' (DontCopy) || The discard all form field.
+
| class="op_enum_value" | '''2''' (DontCopy) || The form fields won't be copied to the destination.
 +
|-
 +
| 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 53:
 
| class="op_param_name" | BookmarksAction
 
| class="op_param_name" | BookmarksAction
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
−
| Specifies the action which the bookmark should be applied to.
+
| 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) || The discard all bookmark which will result in documents without bookmarks.
+
| class="op_enum_value" | '''0''' (DontCopy) || The bookmarks won't be copied at all.
 
|-
 
|-
−
| class="op_enum_value" | '''1''' (CopyAll) || The add all bookmarks to the new documents. 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" | '''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) || The add only related bookmarks to the new documents.
+
| 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 67:
 
| class="op_param_name" | LastSrcMode
 
| class="op_param_name" | LastSrcMode
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
−
| Specifies the select last source mode.
+
| 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) || The set '''LastSrcFile''' param.
+
| class="op_enum_value" | '''0''' (FromFile) || The data will be taken from the '''LastSrcFile''' param.
 
|-
 
|-
−
| class="op_enum_value" | '''1''' (FromOpenedDoc) || The set '''LastSrcDoc''' param.
+
| 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 79:
 
| class="op_param_name" | LastSrcFile
 
| class="op_param_name" | LastSrcFile
 
| style="text-align:center" | String
 
| style="text-align:center" | String
−
| Specifies the path to file.
+
| 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 the path to doc.
+
| Specifies the path to the document.
 
Default value: <tt>'''Empty String'''</tt>
 
Default value: <tt>'''Empty String'''</tt>
 
|-
 
|-
 
| class="op_param_name" | Location
 
| class="op_param_name" | Location
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
−
| Determines if the selected pages will be inserted Before or After the target page.
+
| Determines whether the selected pages will be inserted Before or After the target page.
 
Possible values are:
 
Possible values are:
 
{| class="op_internal_table"
 
{| class="op_internal_table"
 
|-
 
|-
−
| class="op_enum_value" | '''0''' (Before) || Inserted Before the target page.
+
| class="op_enum_value" | '''0''' (Before) || The pages will be inserted Before the target page.
 
|-
 
|-
−
| class="op_enum_value" | '''1''' (After) || Inserted After the target page.
+
| class="op_enum_value" | '''1''' (After) || The pages will be inserted After the target page.
 
|}
 
|}
 
Default value: <tt>'''1''' (After)</tt>
 
Default value: <tt>'''1''' (After)</tt>
Line 100: Line 102:
 
| style="text-align:center" | IUnknown
 
| style="text-align:center" | IUnknown
 
| Specifies the source data ([[PXV:IAFS_Name|IAFS_Name]], [[PXV:IAFS_File|IAFS_File]]).
 
| Specifies the source data ([[PXV:IAFS_Name|IAFS_Name]], [[PXV:IAFS_File|IAFS_File]]).
 +
|-
 +
| class="op_param_name" | AddRootBookmarks
 +
| style="text-align:center" | Boolean
 +
| Specifies whether the root bookmark should be added for the inserted page block.
 
|}
 
|}

Latest revision as of 06:06, 10 May 2019

PDF Editor Layer > Operations > op.document.insertPages > Options


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 position where the pages will be inserted.

Default value: -1

CommentsAction Integer Specifies what should be done to the annotations on pages.

Possible values are:

0 (Copy) The annotations will be copied from the original pages into source destination.
1 (Flatten) The annotations will become a part of the original pages' content.
2 (DontCopy) The annotations won't be copied to the destination.

Default value: 0 (Copy)

FieldsAction Integer Specifies what should be done to the fields on pages.

Possible values are:

0 (Copy) The form fields will be copied from the original pages into source destination.
1 (Flatten) The form fields will become a part of the original pages' content.
2 (DontCopy) The form fields won't be copied to the destination.
3 (CopyWithRename) The form fields will be copied and renamed automatically to unique names if needed.

Default value: 1 (Flatten)

BookmarksAction Integer Specifies the action that would be applied to the bookmarks.

Possible values are:

0 (DontCopy) The bookmarks won't be copied at all.
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.
2 (CopyRelated) Only the related bookmarks will be copied to the destination document.

Default value: 1 (CopyAll)

LastSrcMode Integer Specifies the last selected source mode on dialog.

Possible values are:

0 (FromFile) The data will be taken from the LastSrcFile param.
1 (FromOpenedDoc) The data will be taken from the LastSrcDoc param.

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

Location Integer Determines whether the selected pages will be inserted Before or After the target page.

Possible values are:

0 (Before) The pages will be inserted Before the target page.
1 (After) The pages will be inserted After the target page.

Default value: 1 (After)

Src IUnknown Specifies the source data (IAFS_Name, IAFS_File).
AddRootBookmarks Boolean Specifies whether the root bookmark should be added for the inserted page block.
Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:op_document_insertPages_Options&oldid=51810"