Options

From Tracker Software PDF SDK
Jump to: navigation, search


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 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 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 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.

NewPage Table

Name Type Value
PaperType Integer Specifies how the size of the new page will be chosen.

Possible values are:

0 (Document) If the page is inserted at the beginning of the document, it's size will be copied from the first page of the document. Otherwise it will be the same as the size of the page before the inserted one. This value is invalid if the page is inserted into the new document.
1 (Standard) The size of the new page is defined by the StdPaperIndex and Landscape fields values.
2 (Custom) The size of the new page is defined by the Width, Height and Landscape fields values.
3 (BySource) The size of the new page is defined by the sizes of the inserted images.

Default value: 1 (Standard)

StdPaperIndex Integer If the value of the PaperType field is 1 (Standard), this field specifies the size of the new page.

The list of possible values are shown in the table.

Default value: 4 (A4)

Landscape Boolean If the value of the PaperType field is 1 (Standard) or 2 (Custom), this field specifies whether the orientation of the new page is the landscape.

Default value: false

Width Double If the value of the PaperType field is 2 (Custom), this field specifies the width of the new page in points (1/72 inch).

Default value: 595.276

Height Double If the value of the PaperType field is 2 (Custom), this field specifies the height of the new page in points (1/72 inch).

Default value: 841.89

Margins Dictionary Specifies the margins of the new page.
Rotation Integer Specifies the rotation of the new page in degrees. This value should be divisible by 90.

Default value: 0

Labels Table

Name Type Value
AboveImage Boolean If the value is true, the label will be placed above the image. Otherwise, the label will be placed below the image.

Default value: false

AddBookmark Boolean Specifies whether the bookmark will be added to the label or not.

Default value: false

Para Dictionary Specifies the paragraph parameters of the label.
Font Dictionary Specifies the font parameters of the label.
Text String Specifies the text of the label.

Default value: Empty String

BackColor String Specifies the background color of the label.

Default value: N

Processing Table

Name Type Value
Scale Dictionary Specifies the downsampling options for the images.
Comp Dictionary Specifies the compression options for the images.
Conv Dictionary Specifies the conversion options for the images.

Scale Table

Name Type Value
Color Dictionary Specifies the downsampling options for the true color images.
Grayscale Dictionary Specifies the downsampling options for the grayscale images.
Indexed Dictionary Specifies the downsampling options for the indexed color images.
Mono Dictionary Specifies the downsampling options for the monochrome images.

Color Table (Scale)

Name Type Value
Method Integer Specifies the downsampling algorithm

Possible values are:

0 (None) No downsampling
1 (Linear) Linear downsampling algorithm
2 (Bilinear) Bilinear downsampling algorithm
3 (Bicubic) Bicubic downsampling algorithm

Default value: 0 (None)

To Integer Specifies the target DPI.

Default value: 96

IfAbove Integer Specifies the boundary DPI value. Only images with DPI above specified will be downsampled.

Default value: 128

Grayscale Table (Scale)

Name Type Value
Method Integer Specifies the downsampling algorithm

Possible values are:

0 (None) No downsampling
1 (Linear) Linear downsampling algorithm
2 (Bilinear) Bilinear downsampling algorithm
3 (Bicubic) Bicubic downsampling algorithm

Default value: 0 (None)

To Integer Specifies the target DPI.

Default value: 96

IfAbove Integer Specifies the boundary DPI value. Only images with DPI above specified will be downsampled.

Default value: 128

Indexed Table (Scale)

Name Type Value
Method Integer Specifies the downsampling algorithm

Possible values are:

0 (None) No downsampling
1 (Linear) Linear downsampling algorithm
2 (Bilinear) Bilinear downsampling algorithm
3 (Bicubic) Bicubic downsampling algorithm

Default value: 0 (None)

To Integer Specifies the target DPI.

Default value: 96

IfAbove Integer Specifies the boundary DPI value. Only images with DPI above specified will be downsampled.

Default value: 128

Mono Table (Scale)

Name Type Value
Method Integer Specifies the downsampling algorithm

Possible values are:

0 (None) No downsampling
1 (Linear) Linear downsampling algorithm
2 (Bilinear) Bilinear downsampling algorithm
3 (Bicubic) Bicubic downsampling algorithm

Default value: 0 (None)

To Integer Specifies the target DPI.

Default value: 96

IfAbove Integer Specifies the boundary DPI value. Only images with DPI above specified will be downsampled.

Default value: 128

Compression Table

Name Type Value
Color Dictionary Specifies the compression options for the true color images.
Grayscale Dictionary Specifies the compression options for the grayscale images.
Indexed Dictionary Specifies the compression options for the indexed color images.
Mono Dictionary Specifies the compression options for the monochrome images.

Color Table (Compression)

Name Type Value
Method Integer Specifies the compression method for the true color images.

The list of possible values are shown in the table. Default value: 0 (Auto)

JPEGQuality Integer If the Method value is 0 (JPEG), this field specifies the target quality of the JPEG.

Default value: 75

JPEG2KLossless Boolean If the Method value is 4 (JPEG2K), this field specifies whether the lossless compression will be applied.

Default value: false

Enabled Boolean Specifies whether the compression will be applied for the true color images.

Default value: true

MRC Dictionary Specifies MRC compression options for the true color images.

Grayscale Table (Compression)

Name Type Value
Method Integer Specifies the compression method for the grayscale images.

The list of possible values are shown in the table.

Default value: 0 (Auto)

JPEGQuality Integer If the Method value is 0 (JPEG), this field specifies the target quality of the JPEG.

Default value: 75

JPEG2KLossless Boolean If the Method value is 4 (JPEG2K), this field specifies whether the lossless compression will be applied.

Default value: false

Enabled Boolean Specifies whether the compression will be applied for the grayscale images.

Default value: true

MRC Dictionary Specifies MRC compression options for the grayscale images.

Indexed Table (Compression)

Name Type Value
Enabled Boolean Specifies whether the compression will be applied for the indexed color images.

Default value: true

Method Integer Specifies the compression algorithm for the indexed images.

Possible values are:

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

Default value: 0 (Auto)

Mono Table (Compression)

Name Type Value
Method Integer Specifies whether the compression will be applied for the monochrome images.

The list of possible values are shown in the table.

Default value: 0 (Auto)

JBIG2Method Integer If the Method value is 5 (JBIG2), this field specifies the method of JBIG2 compression.

Possible values are:

0 (Standard) Image is compressed using only the generic JBIG region.
1 (CropBorders) Any white borders are located on an image and excluded from the compression.
2 (Symbols) Implementation of a method similar to the ones described in the "Text image data" section of this wiki article.

Default value: 0 (Standard)

Enabled Boolean Specifies whether the compression will be applied for the monochrome images.

Default value: true

MRC Table

Name Type Value
ForegroundDownsampling Double Specifies the foreground downsampling.

Default value: 4.0

BackgroundDownsampling Double Specifies the background downsampling.

Default value: 2.0

BackgroundCompression Dictionary Specifies the background compression options.
ForegroundCompression Dictionary Specifies the foreground compression options.
MaskCompression Dictionary Specifies the mask compression options.
PresetID String Specifies an unique identifier of special preset of options that exists in Editor's settings. End-user may create multiple presets for different operations to enhance convenience of using. If specified preset already exists then operation will use preset's options to show dialog or perform its work.

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

BackgroundCompression Table (MRC)

Name Type Value
Method Integer Specifies the compression method for the images. The list of possible values are shown in the table.

Default value: 0 (Auto)

JPEGQuality Integer If the Method value is 0 (JPEG), this field specifies the target quality of the JPEG.

Default value: 75

JPEG2KLossless Boolean If the Method value is 4 (JPEG2K), this field specifies whether the lossless compression will be applied.

Default value: false

ForegroundCompression Table (MRC)

Name Type Value
Method Integer Specifies the compression method for the images. The list of possible values are shown in the table.

Default value: 0 (Auto)

JPEGQuality Integer If the Method value is 0 (JPEG), this field specifies the target quality of the JPEG.

Default value: 75

JPEG2KLossless Boolean If the Method value is 4 (JPEG2K), this field specifies whether the lossless compression will be applied.

Default value: false

MaskCompression Table (MRC)

Name Type Value
Method Integer Specifies the compression method for the images.

The list of possible values are shown in the table.

Default value: 0 (Auto)

JBIG2Method Integer If the Method value is 5 (JBIG2), this field specifies the method of JBIG2 compression.

Possible values are:

0 (Standard) Image is compressed using only the generic JBIG region.
1 (CropBorders) Any white borders are located on an image and excluded from the compression.
2 (Symbols) Implementation of a method similar to the ones described in the "Text image data" section of this wiki article.

Default value: 0 (Standard)

Conversion Table

Name Type Value
Color Dictionary Specifies the conversion options for true color images
Grayscale Dictionary Specifies the conversion options for grayscale images
Indexed Dictionary Specifies the conversion options for indexed color images
Mono Dictionary Specifies the conversion options for monochrome images

Color Table (Conversion)

Name Type Value
Method Integer Specifies the conversion method for the true color images.

The list of possible values are shown in the table.

Default value: 0 (None)

Dither Integer Specifies whether the dithering will be applied.

Possible values are:

0 (false)
1 (true)

Default value: 1 (true)

Grayscale Table (Conversion)

Name Type Value
Method Integer Specifies the conversion method for the grayscale images.

The list of possible values are shown in the table.

Default value: 0 (None)

Dither Integer Specifies whether the dithering will be applied.

Possible values are:

0 (false)
1 (true)

Default value: 1 (true)

Indexed Table (Conversion)

Name Type Value
Method Integer Specifies the conversion method for the indexed color images.

The list of possible values are shown in the table.

Default value: 0 (None)

Dither Integer Specifies whether the dithering will be applied.

Possible values are:

0 (false)
1 (true)

Default value: 1 (true)

Mono Table (Conversion)

Name Type Value
Method Integer Specifies the conversion method for the monochrome images.

The list of possible values are shown in the table.

Default value: 0 (None)

Dither Integer Specifies whether the dithering will be applied.

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