Options
From PDF XChange PDF SDK
(Created page with "Category:Editor {{#customTitle:Options}} {{#parentPage:PXV:op_document_addBarcode|Options|property}} {{ToWrite}} {{ToReview}} == Options Table == {| class="wikitable op_...") |
|||
| Line 14: | Line 14: | ||
| class="op_param_name" | Type | | class="op_param_name" | Type | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the type of the barcode that should be added. |
Default value: <tt>'''QRCode'''</tt> | Default value: <tt>'''QRCode'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Page | | class="op_param_name" | Page | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the destination page where the barcode would be placed at. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[PXV:cs_RectF|Pos]] | | class="op_param_name" | [[PXV:cs_RectF|Pos]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies barcode bound rectangle. |
|- | |- | ||
| class="op_param_name" | AlignMode | | class="op_param_name" | AlignMode | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies. | + | | Specifies the alignment flags of the barcode. |
| + | Possible values are: | ||
| + | |||
| + | Vertical: | ||
| + | |||
| + | Top - '''0''', Middle - '''4''', Bottom - '''8''' | ||
| + | |||
| + | Horizontal: | ||
| + | |||
| + | Left - '''0''', Center - '''1''', Right - '''2''' | ||
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| Line 38: | Line 47: | ||
| class="op_param_name" | AdvRotate | | class="op_param_name" | AdvRotate | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the barcode's rotation angle in degrees. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | BgColor | | class="op_param_name" | BgColor | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the barcode's background color. |
Default value: <tt>'''N'''</tt> | Default value: <tt>'''N'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Color | | class="op_param_name" | Color | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies. | + | | Specifies the barcode color. Note that each value should be from 0 to 255. |
Default value: <tt>'''rgbd(0,0,0)'''</tt> | Default value: <tt>'''rgbd(0,0,0)'''</tt> | ||
|- | |- | ||
| class="op_param_name" | AsVector | | class="op_param_name" | AsVector | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the barcode should be in vector format. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
|- | |- | ||
| class="op_param_name" | DPI | | class="op_param_name" | DPI | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the barcode's DPI. |
Default value: <tt>'''200'''</tt> | Default value: <tt>'''200'''</tt> | ||
|- | |- | ||
| class="op_param_name" | AsStamp | | class="op_param_name" | AsStamp | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the barcode should be added as stamp annotation or as part of the pages content. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Data | | class="op_param_name" | Data | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies barcode's data. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | ECCLevel | | class="op_param_name" | ECCLevel | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies barcode's error correction level. |
Default value: <tt>'''1'''</tt> | Default value: <tt>'''1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | WhiteSpaceSize | | class="op_param_name" | WhiteSpaceSize | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies. | + | | Specifies the size of the whitespace that will be used when drawing the barcode. Note that 0 size will use a default size specific to the barcode type. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|} | |} | ||
Revision as of 05:25, 14 March 2016
Options Table
| Name | Type | Value |
|---|---|---|
| Type | String | Specifies the type of the barcode that should be added.
Default value: QRCode |
| Page | Integer | Specifies the destination page where the barcode would be placed at.
Default value: 0 |
| Pos | Dictionary | Specifies barcode bound rectangle. |
| AlignMode | Integer | Specifies the alignment flags of the barcode.
Possible values are: Vertical: Top - 0, Middle - 4, Bottom - 8 Horizontal: Left - 0, Center - 1, Right - 2 Default value: 0 |
| AutoRotate | Boolean | Specifies...
Default value: true |
| AdvRotate | Double | Specifies the barcode's rotation angle in degrees.
Default value: 0.0 |
| BgColor | String | Specifies the barcode's background color.
Default value: N |
| Color | String | Specifies the barcode color. Note that each value should be from 0 to 255.
Default value: rgbd(0,0,0) |
| AsVector | Boolean | Specifies whether the barcode should be in vector format.
Default value: true |
| DPI | Integer | Specifies the barcode's DPI.
Default value: 200 |
| AsStamp | Boolean | Specifies whether the barcode should be added as stamp annotation or as part of the pages content.
Default value: true |
| Data | String | Specifies barcode's data.
Default value: Empty String |
| ECCLevel | Integer | Specifies barcode's error correction level.
Default value: 1 |
| WhiteSpaceSize | Double | Specifies the size of the whitespace that will be used when drawing the barcode. Note that 0 size will use a default size specific to the barcode type.
Default value: 0.0 |
