Options

From PDF XChange PDF SDK
Jump to: navigation, search
(→‎Options Table)
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 source 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 the what will 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>

Revision as of 01:21, 1 March 2016

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 source destination.
Position Integer Specifies the position where the pages will be inserted.

Default value: -1

CommentsAction Integer Specifies the what will 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 the action which the form field should be applied to.

Possible values are:

0 (Copy) The copy all form field.
1 (Flatten) The add the content of form fields to the resulting documents' content.
2 (DontCopy) The discard all form field.

Default value: 1 (Flatten)

BookmarksAction Integer Specifies the action which the bookmark should be applied to.

Possible values are:

0 (DontCopy) The discard all bookmark which will result in documents without bookmarks.
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.
2 (CopyRelated) The add only related bookmarks to the new documents.

Default value: 1 (CopyAll)

LastSrcMode Integer Specifies the select last source mode.

Possible values are:

0 (FromFile) The set LastSrcFile param.
1 (FromOpenedDoc) The set LastSrcDoc param.

Default value: 1 (FromOpenedDoc)

LastSrcFile String Specifies the path to file.

Default value: Empty String

LastSrcDoc String Specifies the path to doc.

Default value: Empty String

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

Possible values are:

0 (Before) Inserted Before the target page.
1 (After) Inserted After the target page.

Default value: 1 (After)

Src IUnknown Specifies the source data (IAFS_Name, IAFS_File).
Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:op_document_insertPages_Options&oldid=48779"