Options
From PDF XChange PDF SDK
| Line 93: | Line 93: | ||
| 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 |
|} | |} | ||
Default value: <tt>'''1''' (Standard)</tt> | Default value: <tt>'''1''' (Standard)</tt> | ||
| Line 109: | Line 109: | ||
| 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 116: | Line 116: | ||
| 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 |
The following default values of base [[PXV:cs_RectF|structure]] are overridden : | The following default values of base [[PXV:cs_RectF|structure]] are overridden : | ||
:<code>top</code>: <tt>'''28.3'''</tt>, | :<code>top</code>: <tt>'''28.3'''</tt>, | ||
| Line 140: | Line 140: | ||
| 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> | ||
|} | |} | ||
Revision as of 05:18, 14 March 2016
Contents
[hide]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...
Default value: -1 |
| PDFStandard | Integer | Specifies...
Default value: 0 |
| AdobeExtLevel | Integer | Specifies...
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 | ||||||||
| 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
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...
Default value: 0 | ||||
| Location | Integer | Specifies...
Possible values are:
Default value: 1 (After) | ||||
| Position | Integer | Specifies...
Default value: -1 |
ColsSep Table
| Name | Type | Value |
|---|---|---|
| Width | Double | Specifies...
Default value: 1.0 |
| Style | Integer | Specifies...
Default value: 0 |
| Color | String | Specifies...
Default value: rgbd(0,0,0) |
Labels Table
| Name | Type | Value |
|---|---|---|
| DrawLine | Boolean | Specifies...
Default value: false |
| LineAbove | Boolean | Specifies...
Default value: false |
| Line | Dictionary | Specifies... |
| 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...
Default value: 1.0 |
| Style | Integer | Specifies...
Default value: 0 |
| Color | String | Specifies...
Default value: rgbd(0,0,0) |
