Options
From PDF XChange PDF SDK
(→NewDoc Table) |
(Label ToWrite removed) |
||
| Line 2: | Line 2: | ||
{{#customTitle:Options}} | {{#customTitle:Options}} | ||
{{#parentPage:PXV:op_textToDoc|Options|property}} | {{#parentPage:PXV:op_textToDoc|Options|property}} | ||
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
Revision as of 23:44, 27 April 2017
Contents
Options Table
| Name | Type | Value |
|---|---|---|
| NewDoc | Dictionary | Specifies the parameters for the new document that would be created if DocID parameter of the TargetDoc dictionary is not valid. |
| NewPage | Dictionary | Specifies the parameters for creating new pages. |
| TargetDoc | Dictionary | Specifies the target document where the text documents would be inserted. |
| Cols | Integer | Specifies the number of the columns on the document page where the text will be inserted.
Default value: 1 |
| ColsGap | Double | Specifies the gap between the columns on the document page where the text will be inserted.
Default value: 20.0 |
| DrawColsSep | Boolean | Specifies whether the separator line will be drawn between columns of text. If count of columns will be 1, this parameter will be ignored
Default value: false |
| ColsSep | Dictionary | Specifies the column separator line parameters |
| Font | Dictionary | Specifies the font parameters of the displayed text |
| Para | Dictionary | Specifies the paragraph parameters of the displayed text. |
| DrawLabels | Boolean | Specifies whether the text label will be drawn at the beginning of each converted text file
Default value: false |
| Labels | Dictionary | Specifies the parameters for the text labels that would be drawn for the inserted text labels. |
NewDoc Table
| Name | Type | Value |
|---|---|---|
| PDFSpec | Integer | Specifies the version of the PDF Specification.
Default value: -1 |
| PDFStandard | Integer | Specifies the PXC_PDFStandard that should be used for the conversion.
Default value: 0 |
| AdobeExtLevel | Integer | Specifies the Adobe Extension Level.
Default value: 0 |
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 (corresponds width of A4 page in pts) | ||||||||
| 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 (corresponds height of A4 page in pts) | ||||||||
| Margins | Dictionary | Specifies the margins of the new page
The following default values of base structure are overridden :
| ||||||||
| Rotation | Integer | Specifies the rotation of the new page in degrees. This value should be divisible by 90.
Default value: 0 |
TargetDoc Table
| Name | Type | Value | ||||
|---|---|---|---|---|---|---|
| DocID | Integer | Specifies the ID of the IPXV_Document.
Default value: 0 | ||||
| Location | Integer | Flag, that specifies the way of inserting new pages into existing document.
Possible values are:
Default value: 1 (After) | ||||
| Position | Integer | Specifies the page index, according to which the new generated pages will be inserted using Location flag. -1 means insert at the end of the document.
Default value: -1 |
ColsSep Table
| Name | Type | Value | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Width | Double | Specifies the thickness of the line
Default value: 1.0 | ||||||||||||||
| Style | Integer | Specifies the style of the line
Possible values are:
Default value: 0 | ||||||||||||||
| Color | String | Specifies the color of the line.
Default value: rgbd(0,0,0) |
Labels Table
| Name | Type | Value |
|---|---|---|
| DrawLine | Boolean | Specifies whether the horizontal line will be drawn within the label
Default value: false |
| LineAbove | Boolean | Specifies the position within the label, where the horizontal line will be drawn. If true the line will be drawn first, otherwise - under the text of label. If there is no text in the label, this parameter will be ignored.
Default value: false |
| Line | Dictionary | Specifies the line parameters of the label. |
| 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 |
Line Table
| Name | Type | Value | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Width | Double | Specifies the thickness of the line
Default value: 1.0 | ||||||||||||||
| Style | Integer | Specifies the style of the line
Possible values are:
Default value: 0 | ||||||||||||||
| Color | String | Specifies the color of the line.
Default value: rgbd(0,0,0) |
