Options

From PDF XChange PDF SDK
Jump to: navigation, search


Options Table

Name Type Value
Flags Integer Specifies flags of the properties that should be changed.

Default value: 0

Title String Specifies document's title.

Default value: Empty String

Author String Specifies document's author.

Default value: Empty String

Subject String Specifies document's subject.

Default value: Empty String

Keywords String Specifies document's keywords.

Default value: Empty String

Creator String Specifies document's creator.

Default value: Empty String

Producer String Specifies document's producer.

Default value: Empty String

CreatorTool String Specifies the program by which the document was created.

Default value: Empty String

CreationDate String Specifies document's creation date.

Default value: Empty String

ModDate String Specifies document's modification date.

Default value: Empty String

Trapped Integer Specifies document's Trapped atom indicating whether the document has been modified to include trapping information.

Default value: -1

PageLayout Integer Specifies page layout type.

Default value: -1

PageMode Integer Specifies page mode type.

Default value: -1

NonFSPageMode Integer Specifies non-full-screen page mode type.

Default value: -1

DestPage Integer Specifies the page that the document will be opened at for the first time.

Default value: 0

DestZoom Double Specifies the zoom that will be applied to the document when it will be opened.

Default value: 0.0

DestZoomMode Integer Specifies the zoom mode that will be applied to the opened document.

Default value: 0

BaseURL String Specifies the base URL for web links in the document.

Default value: Empty String

Language String Specifies language for reading options in the document.

Default value: Empty String

R2L Boolean Specifies whether the text should be read from the right to the left.

Default value: false

ViewFlags Integer Specifies document's view flags. These should be set like this:

(1 << (int)PXC_DocumentViewFlags.DocViewFlag_DisplayDocTitle);

Default value: 0

NoPrintScaling Boolean Specifies whether the document should be scaled when printing.

Default value: false

Duplex Integer Specifies the printing duplex mode.

The list of possible values are shown in the table.

Default value: 0 (Auto)

PaperByPageSize Integer Specifies whether the document's page size should be used as paper size in printing options.

Default value: -1

PrintRange String Specifies the default printing pages range.

Default value: Empty String

NumCopies Integer Specifies the default number of copies that should be created when printing the document.

Default value: 0

ActionWillClose IUnknown Specifies the action list that will be executed when the document is being closed.
ActionWillSave IUnknown Specifies the action list that will be executed when the document is being saved.
ActionDidSave IUnknown Specifies the action list that will be executed after the document was saved.
ActionWillPrint IUnknown Specifies the action list that will be executed when the document is being printed.
ActionDidPrint IUnknown Specifies the action list that will be executed after the document was printed.
Metadata IUnknown Specifies the document's metadata
CustomAdd Array Array of Dictionary

Specifies the custom key list that will be added to the document's metadata.

CustomRemove Array Array of Dictionary

Specifies the custom key list that will be removed from the document's metadata.

CustomAdd Table

Name Type Value
Key String Specifies the key's name.

Default value: Empty String

Value String Specifies the key's value.

Default value: Empty String

CustomRemove Table

Name Type Value
Key String Specifies the key name.

Default value: Empty String