Options
(→Options Table) |
|||
(108 intermediate revisions by one other user not shown) | |||
Line 38: | Line 38: | ||
| class="op_param_name" | AlignH | | class="op_param_name" | AlignH | ||
| style="text-align:center" | Integer | | style="text-align:center" | 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 | + | | 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: <tt>'''TJ_Center'''</tt> | Default value: <tt>'''TJ_Center'''</tt> | ||
|- | |- | ||
| class="op_param_name" | AlignV | | class="op_param_name" | AlignV | ||
| style="text-align:center" | Integer | | style="text-align:center" | 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 | + | | 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: <tt>'''TJ_Middle'''</tt> | Default value: <tt>'''TJ_Middle'''</tt> | ||
|- | |- | ||
Line 62: | Line 62: | ||
| class="op_param_name" | KeepAspect | | class="op_param_name" | KeepAspect | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
− | | Specifies whether the aspect of the image will be kept | + | | Specifies whether the aspect of the image will be kept when it's size would be changed to fit the cell. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
|- | |- | ||
Line 76: | Line 76: | ||
| class="op_param_name" | [[#Processing|Processing]] | | class="op_param_name" | [[#Processing|Processing]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies the parameters for the images processing. | + | | Specifies the parameters for the images processing before it would be inserted into the document. |
|- | |- | ||
| class="op_param_name" | [[#Postprocessing|Postprocessing]] | | class="op_param_name" | [[#Postprocessing|Postprocessing]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the parameters for the images processing after it would be inserted into the document. |
|- | |- | ||
| class="op_param_name" | [[#NewDoc|NewDoc]] | | class="op_param_name" | [[#NewDoc|NewDoc]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the parameters for the new document that would be created if DocID parameter of the [[#TargetDoc|TargetDoc]] dictionary is not valid. |
|- | |- | ||
| 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. |
|} | |} | ||
Line 100: | Line 100: | ||
| class="op_param_name" | PaperType | | class="op_param_name" | PaperType | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies how the size of the new page will be chosen. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
− | | class="op_enum_value" | '''0''' (Document) || ... | + | | class="op_enum_value" | '''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. |
|- | |- | ||
− | | class="op_enum_value" | '''1''' (Standard) || | + | | class="op_enum_value" | '''1''' (Standard) || The size of the new page is defined by the [[#StdPaperIndex|StdPaperIndex]] and [[#Landscape|Landscape]] fields values. |
|- | |- | ||
− | | class="op_enum_value" | '''2''' (Custom) || | + | | class="op_enum_value" | '''2''' (Custom) || The size of the new page is defined by the [[#Width|Width]], [[#Height|Height]] and [[#Landscape|Landscape]] fields values. |
|- | |- | ||
− | | class="op_enum_value" | '''3''' (BySource) || | + | | class="op_enum_value" | '''3''' (BySource) || The size of the new page is defined by the sizes of the inserted images. |
|} | |} | ||
Default value: <tt>'''1''' (Standard)</tt> | Default value: <tt>'''1''' (Standard)</tt> | ||
Line 116: | Line 116: | ||
| class="op_param_name" | StdPaperIndex | | class="op_param_name" | StdPaperIndex | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | | + | | If the value of the [[#PaperType|PaperType]] field is '''1''' (Standard), this field specifies the size of the new page. |
The list of possible values are shown in [[PXV:Params_NamedValues_StandardPapers|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_StandardPapers|the table]]. | ||
Line 123: | Line 123: | ||
| class="op_param_name" | Landscape | | class="op_param_name" | Landscape | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
− | | | + | | If the value of the [[#PaperType|PaperType]] field is '''1''' (Standard) or '''2''' (Custom), this field specifies whether the orientation of the new page is the landscape. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Width | | class="op_param_name" | Width | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
− | | | + | | If the value of the [[#PaperType|PaperType]] field is '''2''' (Custom), this field specifies the width of the new page in points (1/72 inch). |
Default value: <tt>'''595.276'''</tt> | Default value: <tt>'''595.276'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Height | | class="op_param_name" | Height | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
− | | | + | | If the value of the [[#PaperType|PaperType]] field is '''2''' (Custom), this field specifies the height of the new page in points (1/72 inch). |
Default value: <tt>'''841.89'''</tt> | Default value: <tt>'''841.89'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[PXV:cs_RectF|Margins]] | | class="op_param_name" | [[PXV:cs_RectF|Margins]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the margins of the new page. |
|- | |- | ||
| class="op_param_name" | Rotation | | class="op_param_name" | Rotation | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies. | + | | Specifies the rotation of the new page in degrees. This value should be divisible by 90. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|} | |} | ||
Line 155: | Line 155: | ||
| class="op_param_name" | AboveImage | | class="op_param_name" | AboveImage | ||
| style="text-align:center" | Boolean | | style="text-align:center" | 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: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | AddBookmark | | class="op_param_name" | AddBookmark | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
− | | Specifies | + | | Specifies whether the bookmark will be added to the label or not. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[PXV:cs_ParaParams|Para]] | | class="op_param_name" | [[PXV:cs_ParaParams|Para]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the paragraph parameters of the label. |
|- | |- | ||
| class="op_param_name" | [[PXV:cs_FontParams|Font]] | | class="op_param_name" | [[PXV:cs_FontParams|Font]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the font parameters of the label. |
|- | |- | ||
| class="op_param_name" | Text | | class="op_param_name" | Text | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
− | | Specifies | + | | Specifies the text of the label. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | BackColor | | class="op_param_name" | BackColor | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
− | | Specifies | + | | Specifies the background color of the label. |
Default value: <tt>'''N'''</tt> | Default value: <tt>'''N'''</tt> | ||
|} | |} | ||
Line 191: | Line 191: | ||
| class="op_param_name" | [[#Scale|Scale]] | | class="op_param_name" | [[#Scale|Scale]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the downsampling options for the images. |
|- | |- | ||
| class="op_param_name" | [[#Comp|Comp]] | | class="op_param_name" | [[#Comp|Comp]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the compression options for the images. |
|- | |- | ||
| class="op_param_name" | [[#Conv|Conv]] | | class="op_param_name" | [[#Conv|Conv]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the conversion options for the images. |
|} | |} | ||
Line 211: | Line 211: | ||
| class="op_param_name" | [[#Color|Color]] | | class="op_param_name" | [[#Color|Color]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the downsampling options for the true color images. |
|- | |- | ||
| class="op_param_name" | [[#Grayscale|Grayscale]] | | class="op_param_name" | [[#Grayscale|Grayscale]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the downsampling options for the grayscale images. |
|- | |- | ||
| class="op_param_name" | [[#Indexed|Indexed]] | | class="op_param_name" | [[#Indexed|Indexed]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the downsampling options for the indexed color images. |
|- | |- | ||
| class="op_param_name" | [[#Mono|Mono]] | | class="op_param_name" | [[#Mono|Mono]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the downsampling options for the monochrome images. |
|} | |} | ||
− | == Color Table == | + | == Color Table (Scale) == |
{| class="wikitable op_options" id="Color" | {| class="wikitable op_options" id="Color" | ||
Line 235: | Line 235: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the downsampling algorithm |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
− | | class="op_enum_value" | '''0''' (None) || | + | | class="op_enum_value" | '''0''' (None) || No downsampling |
|- | |- | ||
− | | class="op_enum_value" | '''1''' (Linear) || | + | | class="op_enum_value" | '''1''' (Linear) || Linear downsampling algorithm |
|- | |- | ||
− | | class="op_enum_value" | '''2''' (Bilinear) || | + | | class="op_enum_value" | '''2''' (Bilinear) || Bilinear downsampling algorithm |
|- | |- | ||
− | | class="op_enum_value" | '''3''' (Bicubic) || | + | | class="op_enum_value" | '''3''' (Bicubic) || Bicubic downsampling algorithm |
|} | |} | ||
Default value: <tt>'''0''' (None)</tt> | Default value: <tt>'''0''' (None)</tt> | ||
Line 251: | Line 251: | ||
| class="op_param_name" | To | | class="op_param_name" | To | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the target DPI. |
Default value: <tt>'''96'''</tt> | Default value: <tt>'''96'''</tt> | ||
|- | |- | ||
| class="op_param_name" | IfAbove | | class="op_param_name" | IfAbove | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies. | + | | Specifies the boundary DPI value. Only images with DPI above specified will be downsampled. |
Default value: <tt>'''128'''</tt> | Default value: <tt>'''128'''</tt> | ||
|} | |} | ||
− | == Grayscale Table == | + | == Grayscale Table (Scale) == |
{| class="wikitable op_options" id="Grayscale" | {| class="wikitable op_options" id="Grayscale" | ||
Line 269: | Line 269: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the downsampling algorithm |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
− | | class="op_enum_value" | '''0''' (None) || | + | | class="op_enum_value" | '''0''' (None) || No downsampling |
|- | |- | ||
− | | class="op_enum_value" | '''1''' (Linear) || | + | | class="op_enum_value" | '''1''' (Linear) || Linear downsampling algorithm |
|- | |- | ||
− | | class="op_enum_value" | '''2''' (Bilinear) || | + | | class="op_enum_value" | '''2''' (Bilinear) || Bilinear downsampling algorithm |
|- | |- | ||
− | | class="op_enum_value" | '''3''' (Bicubic) || | + | | class="op_enum_value" | '''3''' (Bicubic) || Bicubic downsampling algorithm |
|} | |} | ||
Default value: <tt>'''0''' (None)</tt> | Default value: <tt>'''0''' (None)</tt> | ||
Line 285: | Line 285: | ||
| class="op_param_name" | To | | class="op_param_name" | To | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the target DPI. |
Default value: <tt>'''96'''</tt> | Default value: <tt>'''96'''</tt> | ||
|- | |- | ||
| class="op_param_name" | IfAbove | | class="op_param_name" | IfAbove | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies. | + | | Specifies the boundary DPI value. Only images with DPI above specified will be downsampled. |
Default value: <tt>'''128'''</tt> | Default value: <tt>'''128'''</tt> | ||
|} | |} | ||
− | == Indexed Table == | + | == Indexed Table (Scale) == |
{| class="wikitable op_options" id="Indexed" | {| class="wikitable op_options" id="Indexed" | ||
Line 303: | Line 303: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the downsampling algorithm |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
− | | class="op_enum_value" | '''0''' (None) || | + | | class="op_enum_value" | '''0''' (None) || No downsampling |
|- | |- | ||
− | | class="op_enum_value" | '''1''' (Linear) || | + | | class="op_enum_value" | '''1''' (Linear) || Linear downsampling algorithm |
|- | |- | ||
− | | class="op_enum_value" | '''2''' (Bilinear) || | + | | class="op_enum_value" | '''2''' (Bilinear) || Bilinear downsampling algorithm |
|- | |- | ||
− | | class="op_enum_value" | '''3''' (Bicubic) || | + | | class="op_enum_value" | '''3''' (Bicubic) || Bicubic downsampling algorithm |
|} | |} | ||
Default value: <tt>'''0''' (None)</tt> | Default value: <tt>'''0''' (None)</tt> | ||
Line 319: | Line 319: | ||
| class="op_param_name" | To | | class="op_param_name" | To | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the target DPI. |
Default value: <tt>'''96'''</tt> | Default value: <tt>'''96'''</tt> | ||
|- | |- | ||
| class="op_param_name" | IfAbove | | class="op_param_name" | IfAbove | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies. | + | | Specifies the boundary DPI value. Only images with DPI above specified will be downsampled. |
Default value: <tt>'''128'''</tt> | Default value: <tt>'''128'''</tt> | ||
|} | |} | ||
− | == Mono Table == | + | == Mono Table (Scale) == |
{| class="wikitable op_options" id="Mono" | {| class="wikitable op_options" id="Mono" | ||
Line 337: | Line 337: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the downsampling algorithm |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
− | | class="op_enum_value" | '''0''' (None) || | + | | class="op_enum_value" | '''0''' (None) || No downsampling |
|- | |- | ||
− | | class="op_enum_value" | '''1''' (Linear) || | + | | class="op_enum_value" | '''1''' (Linear) || Linear downsampling algorithm |
|- | |- | ||
− | | class="op_enum_value" | '''2''' (Bilinear) || | + | | class="op_enum_value" | '''2''' (Bilinear) || Bilinear downsampling algorithm |
|- | |- | ||
− | | class="op_enum_value" | '''3''' (Bicubic) || | + | | class="op_enum_value" | '''3''' (Bicubic) || Bicubic downsampling algorithm |
|} | |} | ||
Default value: <tt>'''0''' (None)</tt> | Default value: <tt>'''0''' (None)</tt> | ||
Line 353: | Line 353: | ||
| class="op_param_name" | To | | class="op_param_name" | To | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the target DPI. |
Default value: <tt>'''96'''</tt> | Default value: <tt>'''96'''</tt> | ||
|- | |- | ||
| class="op_param_name" | IfAbove | | class="op_param_name" | IfAbove | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies. | + | | Specifies the boundary DPI value. Only images with DPI above specified will be downsampled. |
Default value: <tt>'''128'''</tt> | Default value: <tt>'''128'''</tt> | ||
|} | |} | ||
− | == | + | == Compression Table == |
{| class="wikitable op_options" id="Comp" | {| class="wikitable op_options" id="Comp" | ||
Line 371: | Line 371: | ||
| class="op_param_name" | [[#Color|Color]] | | class="op_param_name" | [[#Color|Color]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the compression options for the true color images. |
|- | |- | ||
| class="op_param_name" | [[#Grayscale|Grayscale]] | | class="op_param_name" | [[#Grayscale|Grayscale]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the compression options for the grayscale images. |
|- | |- | ||
| class="op_param_name" | [[#Indexed|Indexed]] | | class="op_param_name" | [[#Indexed|Indexed]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the compression options for the indexed color images. |
|- | |- | ||
| class="op_param_name" | [[#Mono|Mono]] | | class="op_param_name" | [[#Mono|Mono]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the compression options for the monochrome images. |
|} | |} | ||
− | == Color Table == | + | == Color Table (Compression) == |
{| class="wikitable op_options" id="Color" | {| class="wikitable op_options" id="Color" | ||
Line 395: | Line 395: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the compression method for the true color images. |
The list of possible values are shown in [[PXV:Params_NamedValues_ImageColorCompMethods|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_ImageColorCompMethods|the table]]. | ||
− | |||
Default value: <tt>'''0''' (Auto)</tt> | Default value: <tt>'''0''' (Auto)</tt> | ||
|- | |- | ||
| class="op_param_name" | JPEGQuality | | class="op_param_name" | JPEGQuality | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | | + | | If the [[#Method|Method]] value is 0 (JPEG), this field specifies the target quality of the JPEG. |
Default value: <tt>'''75'''</tt> | Default value: <tt>'''75'''</tt> | ||
|- | |- | ||
| class="op_param_name" | JPEG2KLossless | | class="op_param_name" | JPEG2KLossless | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
− | | | + | | If the [[#Method|Method]] value is 4 (JPEG2K), this field specifies whether the lossless compression will be applied. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Enabled | | class="op_param_name" | Enabled | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
− | | Specifies | + | | Specifies whether the compression will be applied for the true color images. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[#MRC|MRC]] | | class="op_param_name" | [[#MRC|MRC]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies MRC compression options for the true color images. |
|} | |} | ||
− | == | + | == Grayscale Table (Compression) == |
− | {| class="wikitable op_options" id=" | + | {| class="wikitable op_options" id="Grayscale" |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
! style="width:120pt;" | '''Name''' | ! style="width:120pt;" | '''Name''' | ||
! style="width:60pt;" | '''Type''' | ! style="width:60pt;" | '''Type''' | ||
Line 464: | Line 428: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the compression method for the grayscale images. |
The list of possible values are shown in [[PXV:Params_NamedValues_ImageColorCompMethods|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_ImageColorCompMethods|the table]]. | ||
Line 471: | Line 435: | ||
| class="op_param_name" | JPEGQuality | | class="op_param_name" | JPEGQuality | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | | + | | If the [[#Method|Method]] value is 0 (JPEG), this field specifies the target quality of the JPEG. |
Default value: <tt>'''75'''</tt> | Default value: <tt>'''75'''</tt> | ||
|- | |- | ||
| class="op_param_name" | JPEG2KLossless | | class="op_param_name" | JPEG2KLossless | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
− | | | + | | If the [[#Method|Method]] value is 4 (JPEG2K), this field specifies whether the lossless compression will be applied. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
+ | |- | ||
+ | | class="op_param_name" | Enabled | ||
+ | | style="text-align:center" | Boolean | ||
+ | | Specifies whether the compression will be applied for the grayscale images. | ||
+ | Default value: <tt>'''true'''</tt> | ||
+ | |- | ||
+ | | class="op_param_name" | [[#MRC|MRC]] | ||
+ | | style="text-align:center" | Dictionary | ||
+ | | Specifies MRC compression options for the grayscale images. | ||
|} | |} | ||
− | == | + | == Indexed Table (Compression) == |
− | {| class="wikitable op_options" id=" | + | {| class="wikitable op_options" id="Indexed" |
! style="width:120pt;" | '''Name''' | ! style="width:120pt;" | '''Name''' | ||
! style="width:60pt;" | '''Type''' | ! style="width:60pt;" | '''Type''' | ||
! '''Value''' | ! '''Value''' | ||
+ | |- | ||
+ | | class="op_param_name" | Enabled | ||
+ | | style="text-align:center" | Boolean | ||
+ | | Specifies whether the compression will be applied for the indexed color images. | ||
+ | Default value: <tt>'''true'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the compression algorithm for the indexed images. |
− | + | Possible values are: | |
− | + | {| class="op_internal_table" | |
− | + | ||
|- | |- | ||
− | | class=" | + | | class="op_enum_value" | '''0''' (Auto) |
− | + | ||
− | + | ||
− | + | ||
|- | |- | ||
− | | class=" | + | | class="op_enum_value" | '''1''' (PackBits) |
− | | | + | |- |
− | | | + | | class="op_enum_value" | '''2''' (ZIP) |
− | Default value: <tt>''' | + | |- |
+ | | class="op_enum_value" | '''3''' (LZW) | ||
+ | |} | ||
+ | Default value: <tt>'''0''' (Auto)</tt> | ||
|} | |} | ||
− | == | + | == Mono Table (Compression) == |
− | {| class="wikitable op_options" id=" | + | {| class="wikitable op_options" id="Mono" |
! style="width:120pt;" | '''Name''' | ! style="width:120pt;" | '''Name''' | ||
! style="width:60pt;" | '''Type''' | ! style="width:60pt;" | '''Type''' | ||
Line 514: | Line 491: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies whether the compression will be applied for the monochrome images. |
The list of possible values are shown in [[PXV:Params_NamedValues_ImageMonoCompMethods|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_ImageMonoCompMethods|the table]]. | ||
Line 521: | Line 498: | ||
| class="op_param_name" | JBIG2Method | | class="op_param_name" | JBIG2Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | | + | | If the [[#Method|Method]] value is 5 (JBIG2), this field specifies the method of JBIG2 compression. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
− | | class="op_enum_value" | '''0''' (Standard) || | + | | class="op_enum_value" | '''0''' (Standard) || Image is compressed using only the generic JBIG region. |
|- | |- | ||
− | | class="op_enum_value" | '''1''' (CropBorders) || | + | | class="op_enum_value" | '''1''' (CropBorders) || Any white borders are located on an image and excluded from the compression. |
|- | |- | ||
− | | class="op_enum_value" | '''2''' (Symbols) || ... | + | | class="op_enum_value" | '''2''' (Symbols) || Implementation of a method similar to the ones described in the "Text image data" section of this [http://en.wikipedia.org/wiki/JBIG2 wiki article]. |
|} | |} | ||
Default value: <tt>'''0''' (Standard)</tt> | Default value: <tt>'''0''' (Standard)</tt> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| class="op_param_name" | Enabled | | class="op_param_name" | Enabled | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
− | | Specifies | + | | Specifies whether the compression will be applied for the monochrome images. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
Line 577: | Line 525: | ||
| class="op_param_name" | ForegroundDownsampling | | class="op_param_name" | ForegroundDownsampling | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
− | | Specifies | + | | Specifies the foreground downsampling. |
Default value: <tt>'''4.0'''</tt> | Default value: <tt>'''4.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | BackgroundDownsampling | | class="op_param_name" | BackgroundDownsampling | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
− | | Specifies | + | | Specifies the background downsampling. |
Default value: <tt>'''2.0'''</tt> | Default value: <tt>'''2.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[#BackgroundCompression|BackgroundCompression]] | | class="op_param_name" | [[#BackgroundCompression|BackgroundCompression]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the background compression options. |
|- | |- | ||
| class="op_param_name" | [[#ForegroundCompression|ForegroundCompression]] | | class="op_param_name" | [[#ForegroundCompression|ForegroundCompression]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the foreground compression options. |
|- | |- | ||
| class="op_param_name" | [[#MaskCompression|MaskCompression]] | | class="op_param_name" | [[#MaskCompression|MaskCompression]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the mask compression options. |
|- | |- | ||
| class="op_param_name" | PresetID | | class="op_param_name" | PresetID | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
− | | Specifies... | + | | 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: <tt>'''{6C1A9BCC-C143-4F76-A7D4-250CA7D9E5DF}'''</tt> | Default value: <tt>'''{6C1A9BCC-C143-4F76-A7D4-250CA7D9E5DF}'''</tt> | ||
|} | |} | ||
− | == BackgroundCompression Table == | + | == BackgroundCompression Table (MRC) == |
{| class="wikitable op_options" id="BackgroundCompression" | {| class="wikitable op_options" id="BackgroundCompression" | ||
Line 612: | Line 560: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies. | + | | Specifies the compression method for the images. The list of possible values are shown in [[PXV:Params_NamedValues_ImageColorCompMethods|the table]]. |
− | The list of possible values are shown in [[PXV:Params_NamedValues_ImageColorCompMethods|the table]]. | + | |
Default value: <tt>'''0''' (Auto)</tt> | Default value: <tt>'''0''' (Auto)</tt> | ||
Line 619: | Line 566: | ||
| class="op_param_name" | JPEGQuality | | class="op_param_name" | JPEGQuality | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | | + | | If the [[#Method|Method]] value is 0 (JPEG), this field specifies the target quality of the JPEG. |
Default value: <tt>'''75'''</tt> | Default value: <tt>'''75'''</tt> | ||
|- | |- | ||
| class="op_param_name" | JPEG2KLossless | | class="op_param_name" | JPEG2KLossless | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
− | | | + | | If the [[#Method|Method]] value is 4 (JPEG2K), this field specifies whether the lossless compression will be applied. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|} | |} | ||
− | == ForegroundCompression Table == | + | == ForegroundCompression Table (MRC) == |
{| class="wikitable op_options" id="ForegroundCompression" | {| class="wikitable op_options" id="ForegroundCompression" | ||
Line 637: | Line 584: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies. | + | | Specifies the compression method for the images. The list of possible values are shown in [[PXV:Params_NamedValues_ImageColorCompMethods|the table]]. |
− | The list of possible values are shown in [[PXV:Params_NamedValues_ImageColorCompMethods|the table]]. | + | |
Default value: <tt>'''0''' (Auto)</tt> | Default value: <tt>'''0''' (Auto)</tt> | ||
Line 644: | Line 590: | ||
| class="op_param_name" | JPEGQuality | | class="op_param_name" | JPEGQuality | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | | + | | If the [[#Method|Method]] value is 0 (JPEG), this field specifies the target quality of the JPEG. |
Default value: <tt>'''75'''</tt> | Default value: <tt>'''75'''</tt> | ||
|- | |- | ||
| class="op_param_name" | JPEG2KLossless | | class="op_param_name" | JPEG2KLossless | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
− | | | + | | If the [[#Method|Method]] value is 4 (JPEG2K), this field specifies whether the lossless compression will be applied. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|} | |} | ||
− | == MaskCompression Table == | + | == MaskCompression Table (MRC) == |
{| class="wikitable op_options" id="MaskCompression" | {| class="wikitable op_options" id="MaskCompression" | ||
Line 662: | Line 608: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the compression method for the images. |
The list of possible values are shown in [[PXV:Params_NamedValues_ImageMonoCompMethods|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_ImageMonoCompMethods|the table]]. | ||
Line 669: | Line 615: | ||
| class="op_param_name" | JBIG2Method | | class="op_param_name" | JBIG2Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | | + | | If the [[#Method|Method]] value is 5 (JBIG2), this field specifies the method of JBIG2 compression. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
− | | class="op_enum_value" | '''0''' (Standard) || | + | | class="op_enum_value" | '''0''' (Standard) || Image is compressed using only the generic JBIG region. |
|- | |- | ||
− | | class="op_enum_value" | '''1''' (CropBorders) || | + | | class="op_enum_value" | '''1''' (CropBorders) || Any white borders are located on an image and excluded from the compression. |
|- | |- | ||
− | | class="op_enum_value" | '''2''' (Symbols) || ... | + | | class="op_enum_value" | '''2''' (Symbols) || Implementation of a method similar to the ones described in the "Text image data" section of this [http://en.wikipedia.org/wiki/JBIG2 wiki article]. |
|} | |} | ||
Default value: <tt>'''0''' (Standard)</tt> | Default value: <tt>'''0''' (Standard)</tt> | ||
|} | |} | ||
− | == | + | == Conversion Table == |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
{| class="wikitable op_options" id="Conv" | {| class="wikitable op_options" id="Conv" | ||
Line 754: | Line 637: | ||
| class="op_param_name" | [[#Color|Color]] | | class="op_param_name" | [[#Color|Color]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the conversion options for true color images |
|- | |- | ||
| class="op_param_name" | [[#Grayscale|Grayscale]] | | class="op_param_name" | [[#Grayscale|Grayscale]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the conversion options for grayscale images |
|- | |- | ||
| class="op_param_name" | [[#Indexed|Indexed]] | | class="op_param_name" | [[#Indexed|Indexed]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the conversion options for indexed color images |
|- | |- | ||
| class="op_param_name" | [[#Mono|Mono]] | | class="op_param_name" | [[#Mono|Mono]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies | + | | Specifies the conversion options for monochrome images |
|} | |} | ||
− | == Color Table == | + | == Color Table (Conversion) == |
{| class="wikitable op_options" id="Color" | {| class="wikitable op_options" id="Color" | ||
Line 778: | Line 661: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the conversion method for the true color images. |
The list of possible values are shown in [[PXV:Params_NamedValues_ImageConvMethods|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_ImageConvMethods|the table]]. | ||
Line 785: | Line 668: | ||
| class="op_param_name" | Dither | | class="op_param_name" | Dither | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies whether the dithering will be applied. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
− | | class="op_enum_value" | '''0''' (false) | + | | class="op_enum_value" | '''0''' (false) |
|- | |- | ||
− | | class="op_enum_value" | '''1''' (true) | + | | class="op_enum_value" | '''1''' (true) |
|} | |} | ||
Default value: <tt>'''1''' (true)</tt> | Default value: <tt>'''1''' (true)</tt> | ||
|} | |} | ||
− | == Grayscale Table == | + | == Grayscale Table (Conversion) == |
{| class="wikitable op_options" id="Grayscale" | {| class="wikitable op_options" id="Grayscale" | ||
Line 805: | Line 688: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the conversion method for the grayscale images. |
The list of possible values are shown in [[PXV:Params_NamedValues_ImageConvMethods|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_ImageConvMethods|the table]]. | ||
Line 812: | Line 695: | ||
| class="op_param_name" | Dither | | class="op_param_name" | Dither | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies whether the dithering will be applied. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
− | | class="op_enum_value" | '''0''' (false) | + | | class="op_enum_value" | '''0''' (false) |
|- | |- | ||
− | | class="op_enum_value" | '''1''' (true) | + | | class="op_enum_value" | '''1''' (true) |
|} | |} | ||
Default value: <tt>'''1''' (true)</tt> | Default value: <tt>'''1''' (true)</tt> | ||
|} | |} | ||
− | == Indexed Table == | + | == Indexed Table (Conversion) == |
{| class="wikitable op_options" id="Indexed" | {| class="wikitable op_options" id="Indexed" | ||
Line 832: | Line 715: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the conversion method for the indexed color images. |
The list of possible values are shown in [[PXV:Params_NamedValues_ImageConvMethods|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_ImageConvMethods|the table]]. | ||
Line 839: | Line 722: | ||
| class="op_param_name" | Dither | | class="op_param_name" | Dither | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies whether the dithering will be applied. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
− | | class="op_enum_value" | '''0''' (false) | + | | class="op_enum_value" | '''0''' (false) |
|- | |- | ||
− | | class="op_enum_value" | '''1''' (true) | + | | class="op_enum_value" | '''1''' (true) |
|} | |} | ||
Default value: <tt>'''1''' (true)</tt> | Default value: <tt>'''1''' (true)</tt> | ||
|} | |} | ||
− | == Mono Table == | + | == Mono Table (Conversion) == |
{| class="wikitable op_options" id="Mono" | {| class="wikitable op_options" id="Mono" | ||
Line 859: | Line 742: | ||
| class="op_param_name" | Method | | class="op_param_name" | Method | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the conversion method for the monochrome images. |
The list of possible values are shown in [[PXV:Params_NamedValues_ImageConvMethods|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_ImageConvMethods|the table]]. | ||
Line 866: | Line 749: | ||
| class="op_param_name" | Dither | | class="op_param_name" | Dither | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies whether the dithering will be applied. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
− | | class="op_enum_value" | '''0''' (false) | + | | class="op_enum_value" | '''0''' (false) |
|- | |- | ||
− | | class="op_enum_value" | '''1''' (true) | + | | class="op_enum_value" | '''1''' (true) |
|} | |} | ||
Default value: <tt>'''1''' (true)</tt> | Default value: <tt>'''1''' (true)</tt> |
Latest revision as of 09:19, 13 June 2016
Contents
- 1 Options Table
- 2 NewPage Table
- 3 Labels Table
- 4 Processing Table
- 5 Scale Table
- 6 Color Table (Scale)
- 7 Grayscale Table (Scale)
- 8 Indexed Table (Scale)
- 9 Mono Table (Scale)
- 10 Compression Table
- 11 Color Table (Compression)
- 12 Grayscale Table (Compression)
- 13 Indexed Table (Compression)
- 14 Mono Table (Compression)
- 15 MRC Table
- 16 BackgroundCompression Table (MRC)
- 17 ForegroundCompression Table (MRC)
- 18 MaskCompression Table (MRC)
- 19 Conversion Table
- 20 Color Table (Conversion)
- 21 Grayscale Table (Conversion)
- 22 Indexed Table (Conversion)
- 23 Mono Table (Conversion)
- 24 Postprocessing Table
- 25 OCR Table
- 26 ExtParams Table
- 27 NewDoc Table
- 28 TargetDoc Table
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
Default value: 1 (After) | ||||
Position | Integer | Specifies...
Default value: -1 |