Options

From PDF XChange PDF SDK
Jump to: navigation, search
(Options Table)
(Options Table)
Line 88: Line 88:
 
| class="op_param_name" | [[#TargetDoc|TargetDoc]]
 
| class="op_param_name" | [[#TargetDoc|TargetDoc]]
 
| style="text-align:center" | Dictionary
 
| style="text-align:center" | Dictionary
| Specifies...
+
| Specifies the target document where the images would be inserted. if DocID parameter of the [[#TargetDoc|TargetDoc]] dictionary is not valid - new document will be created.
 
|}
 
|}
  

Revision as of 00:45, 16 June 2015


Options Table

Name Type Value
NewPage Dictionary Specifies the parameters for creating new pages.
Cols Integer Specifies the number of the columns on the document page where the images will be inserted.

Default value: 1

Rows Integer Specifies the number of the rows on the document page where the images will be inserted.

Default value: 1

ColsGap Double Specifies the gap between the columns on the document page where the images will be inserted.

Default value: 12.0

RowsGap Double Specifies the gap between the rows on the document page where the images will be inserted.

Default value: 12.0

AlignH Integer Specifies the horizontal alignment of the image. Can be set to TJ_Left, TJ_Right or TJ_Center values of the PXV:PXC_TextJustification:PXC_TextJustification enumeration.

Default value: TJ_Center

AlignV Integer Specifies the vertical alignment of the image. Can be set to TJ_Top, TJ_Bottom or TJ_Middle values of the PXV:PXC_TextJustification:PXC_TextJustification enumeration.

Default value: TJ_Middle

FitType Integer Specifies how the image will be fitted into the cell.

Possible values are:

0 (Off) Image will be cut by the borders of the cell.
1 (FitToCell) Size of the image will be decreased or increased to fit the cell if needed.
2 (ReduceToCell) Size of the image will be decreased to fit the cell if needed.

Default value: 2 (ReduceToCell)

KeepAspect Boolean Specifies whether the aspect of the image will be kept or not when it's size would be changed to fit the cell.

Default value: true

DrawLabels Boolean If true, the Labels will be drawn for the inserted images.

Default value: false

Labels Dictionary Specifies the parameters for the labels that would be drawn for the inserted images.
Processing Dictionary Specifies the parameters for the images processing before it would be inserted into the document.
Postprocessing Dictionary Specifies the parameters for the images processing after it would be inserted into the document.
NewDoc Dictionary Specifies the parameters for the new document that would be created if DocID parameter of the TargetDoc dictionary is not valid.
TargetDoc Dictionary Specifies the target document where the images would be inserted. if DocID parameter of the TargetDoc dictionary is not valid - new document will be created.

NewPage Table

Name Type Value
PaperType Integer Specifies...

Possible values are:

0 (Document) ...
1 (Standard) ...
2 (Custom) ...
3 (BySource) ...

Default value: 1 (Standard)

StdPaperIndex Integer Specifies...

The list of possible values are shown in the table.

Default value: 4 (A4)

Landscape Boolean Specifies...

Default value: false

Width Double Specifies...

Default value: 595.276

Height Double Specifies...

Default value: 841.89

Margins Dictionary Specifies...
Rotation Integer Specifies...

Default value: 0

Labels Table

Name Type Value
AboveImage Boolean Specifies...

Default value: false

AddBookmark Boolean Specifies...

Default value: false

Para Dictionary Specifies...
Font Dictionary Specifies...
Text String Specifies...

Default value: Empty String

BackColor String Specifies...

Default value: N

Processing Table

Name Type Value
Scale Dictionary Specifies...
Comp Dictionary Specifies...
Conv Dictionary Specifies...

Scale Table

Name Type Value
Color Dictionary Specifies...
Grayscale Dictionary Specifies...
Indexed Dictionary Specifies...
Mono Dictionary Specifies...

Color Table

Name Type Value
Method Integer Specifies...

Possible values are:

0 (None) ...
1 (Linear) ...
2 (Bilinear) ...
3 (Bicubic) ...

Default value: 0 (None)

To Integer Specifies...

Default value: 96

IfAbove Integer Specifies...

Default value: 128

Grayscale Table

Name Type Value
Method Integer Specifies...

Possible values are:

0 (None) ...
1 (Linear) ...
2 (Bilinear) ...
3 (Bicubic) ...

Default value: 0 (None)

To Integer Specifies...

Default value: 96

IfAbove Integer Specifies...

Default value: 128

Indexed Table

Name Type Value
Method Integer Specifies...

Possible values are:

0 (None) ...
1 (Linear) ...
2 (Bilinear) ...
3 (Bicubic) ...

Default value: 0 (None)

To Integer Specifies...

Default value: 96

IfAbove Integer Specifies...

Default value: 128

Mono Table

Name Type Value
Method Integer Specifies...

Possible values are:

0 (None) ...
1 (Linear) ...
2 (Bilinear) ...
3 (Bicubic) ...

Default value: 0 (None)

To Integer Specifies...

Default value: 96

IfAbove Integer Specifies...

Default value: 128

Comp Table

Name Type Value
Color Dictionary Specifies...
Grayscale Dictionary Specifies...
Indexed Dictionary Specifies...
Mono Dictionary Specifies...

Color Table

Name Type Value
Method Integer Specifies...

The list of possible values are shown in the table.

Default value: 0 (Auto)

JPEGQuality Integer Specifies...

Default value: 75

JPEG2KLossless Boolean Specifies...

Default value: false

Enabled Boolean Specifies...

Default value: true

MRC Dictionary Specifies...

MRC Table

Name Type Value
ForegroundDownsampling Double Specifies...

Default value: 4.0

BackgroundDownsampling Double Specifies...

Default value: 2.0

BackgroundCompression Dictionary Specifies...
ForegroundCompression Dictionary Specifies...
MaskCompression Dictionary Specifies...
PresetID String Specifies...

Default value: {6C1A9BCC-C143-4F76-A7D4-250CA7D9E5DF}

BackgroundCompression Table

Name Type Value
Method Integer Specifies...

The list of possible values are shown in the table.

Default value: 0 (Auto)

JPEGQuality Integer Specifies...

Default value: 75

JPEG2KLossless Boolean Specifies...

Default value: false

ForegroundCompression Table

Name Type Value
Method Integer Specifies...

The list of possible values are shown in the table.

Default value: 0 (Auto)

JPEGQuality Integer Specifies...

Default value: 75

JPEG2KLossless Boolean Specifies...

Default value: false

MaskCompression Table

Name Type Value
Method Integer Specifies...

The list of possible values are shown in the table.

Default value: 0 (Auto)

JBIG2Method Integer Specifies...

Possible values are:

0 (Standard) ...
1 (CropBorders) ...
2 (Symbols) ...

Default value: 0 (Standard)

Grayscale Table

Name Type Value
Method Integer Specifies...

The list of possible values are shown in the table.

Default value: 0 (Auto)

JPEGQuality Integer Specifies...

Default value: 75

JPEG2KLossless Boolean Specifies...

Default value: false

Enabled Boolean Specifies...

Default value: true

MRC Dictionary Specifies...

MRC Table

Name Type Value
ForegroundDownsampling Double Specifies...

Default value: 4.0

BackgroundDownsampling Double Specifies...

Default value: 2.0

BackgroundCompression Dictionary Specifies...
ForegroundCompression Dictionary Specifies...
MaskCompression Dictionary Specifies...
PresetID String Specifies...

Default value: {6C1A9BCC-C143-4F76-A7D4-250CA7D9E5DF}

BackgroundCompression Table

Name Type Value
Method Integer Specifies...

The list of possible values are shown in the table.

Default value: 0 (Auto)

JPEGQuality Integer Specifies...

Default value: 75

JPEG2KLossless Boolean Specifies...

Default value: false

ForegroundCompression Table

Name Type Value
Method Integer Specifies...

The list of possible values are shown in the table.

Default value: 0 (Auto)

JPEGQuality Integer Specifies...

Default value: 75

JPEG2KLossless Boolean Specifies...

Default value: false

MaskCompression Table

Name Type Value
Method Integer Specifies...

The list of possible values are shown in the table.

Default value: 0 (Auto)

JBIG2Method Integer Specifies...

Possible values are:

0 (Standard) ...
1 (CropBorders) ...
2 (Symbols) ...

Default value: 0 (Standard)

Indexed Table

Name Type Value
Enabled Boolean Specifies...

Default value: true

Method Integer Specifies...

Possible values are:

0 (Auto) ...
1 (PackBits) ...
2 (ZIP) ...
3 (LZW) ...

Default value: 0 (Auto)

Mono Table

Name Type Value
Method Integer Specifies...

The list of possible values are shown in the table.

Default value: 0 (Auto)

JBIG2Method Integer Specifies...

Possible values are:

0 (Standard) ...
1 (CropBorders) ...
2 (Symbols) ...

Default value: 0 (Standard)

Enabled Boolean Specifies...

Default value: true

Conv Table

Name Type Value
Color Dictionary Specifies...
Grayscale Dictionary Specifies...
Indexed Dictionary Specifies...
Mono Dictionary Specifies...

Color Table

Name Type Value
Method Integer Specifies...

The list of possible values are shown in the table.

Default value: 0 (None)

Dither Integer Specifies...

Possible values are:

0 (false) ...
1 (true) ...

Default value: 1 (true)

Grayscale Table

Name Type Value
Method Integer Specifies...

The list of possible values are shown in the table.

Default value: 0 (None)

Dither Integer Specifies...

Possible values are:

0 (false) ...
1 (true) ...

Default value: 1 (true)

Indexed Table

Name Type Value
Method Integer Specifies...

The list of possible values are shown in the table.

Default value: 0 (None)

Dither Integer Specifies...

Possible values are:

0 (false) ...
1 (true) ...

Default value: 1 (true)

Mono Table

Name Type Value
Method Integer Specifies...

The list of possible values are shown in the table.

Default value: 0 (None)

Dither Integer Specifies...

Possible values are:

0 (false) ...
1 (true) ...

Default value: 1 (true)

Postprocessing Table

Name Type Value
Despeckle Boolean Specifies...

Default value: false

Deskew Boolean Specifies...

Default value: false

OCR Dictionary Specifies...

OCR Table

Name Type Value
ExtParams Dictionary Specifies...
Enabled Boolean Specifies...

Default value: false

ExtParams Table

Name Type Value

NewDoc Table

Name Type Value
PDFSpec Integer Specifies...

Default value: -1

PDFStandard Integer Specifies...

Default value: 0

AdobeExtLevel Integer Specifies...

Default value: 0

TargetDoc Table

Name Type Value
DocID Integer Specifies...

Default value: 0

Location Integer Specifies...

Possible values are:

0 (Before) ...
1 (After) ...

Default value: 1 (After)

Position Integer Specifies...

Default value: -1