Options

From PDF XChange PDF SDK
Jump to: navigation, search
(Options Table)
(Label ToWrite removed)
 
Line 2: Line 2:
 
{{#customTitle:Options}}
 
{{#customTitle:Options}}
 
{{#parentPage:PXV:op_document_extractPages|Options|property}}
 
{{#parentPage:PXV:op_document_extractPages|Options|property}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  

Latest revision as of 02: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:

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.

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)

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:

0 (AllToOneDoc) The extracted pages will be generated into new document and won't be saved to disk.
1 (AllToOneFile) All of the extracted pages will be saved on disk with specified name.
2 (EachToFile) Each page will be extracted into separate document.
3 (EachRangeToFile) The pages will be extracted by page range blocks that were specified in the PagesRange section.

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