Options
From PDF XChange PDF SDK
(→NewPage Table) |
|||
| (33 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
{{#customTitle:Options}} | {{#customTitle:Options}} | ||
{{#parentPage:PXV:op_textToDoc|Options|property}} | {{#parentPage:PXV:op_textToDoc|Options|property}} | ||
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| Line 18: | Line 18: | ||
| class="op_param_name" | [[#NewPage|NewPage]] | | class="op_param_name" | [[#NewPage|NewPage]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the parameters for creating new pages. |
|- | |- | ||
| class="op_param_name" | [[#TargetDoc|TargetDoc]] | | class="op_param_name" | [[#TargetDoc|TargetDoc]] | ||
| Line 26: | Line 26: | ||
| class="op_param_name" | Cols | | class="op_param_name" | Cols | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the number of the columns on the document page where the text will be inserted. |
Default value: <tt>'''1'''</tt> | Default value: <tt>'''1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | ColsGap | | class="op_param_name" | ColsGap | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the gap between the columns on the document page where the text will be inserted. |
Default value: <tt>'''20.0'''</tt> | Default value: <tt>'''20.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | DrawColsSep | | class="op_param_name" | DrawColsSep | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies. | + | | 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: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[#ColsSep|ColsSep]] | | class="op_param_name" | [[#ColsSep|ColsSep]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the column separator line parameters |
|- | |- | ||
| 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 displayed text |
|- | |- | ||
| 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 displayed text. |
|- | |- | ||
| class="op_param_name" | DrawLabels | | class="op_param_name" | DrawLabels | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the text label will be drawn at the beginning of each converted text file |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[#Labels|Labels]] | | class="op_param_name" | [[#Labels|Labels]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the parameters for the text labels that would be drawn for the inserted text labels. |
|} | |} | ||
| Line 70: | Line 70: | ||
| class="op_param_name" | PDFSpec | | class="op_param_name" | PDFSpec | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the version of the PDF Specification. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | PDFStandard | | class="op_param_name" | PDFStandard | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the [[PXV:PXC_PDFStandard|PXC_PDFStandard]] that should be used for the conversion. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | AdobeExtLevel | | class="op_param_name" | AdobeExtLevel | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the Adobe Extension Level. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|} | |} | ||
| 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. |
| − | | | + | |
| − | | | + | |
|} | |} | ||
Default value: <tt>'''1''' (Standard)</tt> | Default value: <tt>'''1''' (Standard)</tt> | ||
| Line 109: | Line 107: | ||
| 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 114: | ||
| 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''' (corresponds width of A4 page in pts)</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''' (corresponds height of A4 page in pts)</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 138: | ||
| 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 153: | Line 151: | ||
| class="op_param_name" | DocID | | class="op_param_name" | DocID | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the ID of the [[PXV:IPXV_Document|IPXV_Document]]. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Location | | class="op_param_name" | Location | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | | + | | Flag, that specifies the way of inserting new pages into existing document. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
| − | | class="op_enum_value" | '''0''' (Before) || | + | | class="op_enum_value" | '''0''' (Before) || Means, pages will be inserted before specified [[#Position|Position]] |
|- | |- | ||
| − | | class="op_enum_value" | '''1''' (After) || | + | | class="op_enum_value" | '''1''' (After) || Means, pages will be inserted after specified [[#Position|Position]] |
|} | |} | ||
Default value: <tt>'''1''' (After)</tt> | Default value: <tt>'''1''' (After)</tt> | ||
| Line 170: | Line 168: | ||
| class="op_param_name" | Position | | class="op_param_name" | Position | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies. | + | | Specifies the page index, according to which the new generated pages will be inserted using [[#Location|Location]] flag. -1 means insert at the end of the document. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|} | |} | ||
| Line 183: | Line 181: | ||
| class="op_param_name" | Width | | class="op_param_name" | Width | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the thickness of the line |
Default value: <tt>'''1.0'''</tt> | Default value: <tt>'''1.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Style | | class="op_param_name" | Style | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies. | + | | Specifies the style of the line |
| + | Possible values are: | ||
| + | {| class="op_internal_table" | ||
| + | |- | ||
| + | | class="op_enum_value" | '''0''' (Solid) || Specifies solid line style. | ||
| + | |- | ||
| + | | class="op_enum_value" | '''1''' (Dashed) || Specifies line style with scheme: 2 white - 2 black | ||
| + | |- | ||
| + | | class="op_enum_value" | '''2''' (Dashed) || Specifies line style with scheme: 3 white - 3 black | ||
| + | |- | ||
| + | | class="op_enum_value" | '''3''' (Dashed) || Specifies line style with scheme: 4 white - 4 black | ||
| + | |- | ||
| + | | class="op_enum_value" | '''4''' (Dashed) || Specifies line style with scheme: 4-3-2-3 | ||
| + | |- | ||
| + | | class="op_enum_value" | '''5''' (Dashed) || Specifies line style with scheme: 4-3-16-3 | ||
| + | |- | ||
| + | | class="op_enum_value" | '''6''' (Dashed) || Specifies line style with scheme: 8-4-4-4 | ||
| + | |} | ||
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Color | | class="op_param_name" | Color | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the color of the line. |
Default value: <tt>'''rgbd(0,0,0)'''</tt> | Default value: <tt>'''rgbd(0,0,0)'''</tt> | ||
|} | |} | ||
| Line 206: | Line 221: | ||
| class="op_param_name" | DrawLine | | class="op_param_name" | DrawLine | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the horizontal line will be drawn within the label |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | LineAbove | | class="op_param_name" | LineAbove | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies... | + | | Specifies the position within the label, where the horizontal line will be drawn. If <tt>'''true'''</tt> 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: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[#Line|Line]] | | class="op_param_name" | [[#Line|Line]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the line parameters of the label. |
|- | |- | ||
| 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 246: | Line 261: | ||
| class="op_param_name" | Width | | class="op_param_name" | Width | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the thickness of the line |
Default value: <tt>'''1.0'''</tt> | Default value: <tt>'''1.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Style | | class="op_param_name" | Style | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the style of the line |
| + | Possible values are: | ||
| + | {| class="op_internal_table" | ||
| + | |- | ||
| + | | class="op_enum_value" | '''0''' (Solid) || Specifies solid line style | ||
| + | |- | ||
| + | | class="op_enum_value" | '''1''' (Dashed) || Specifies line style with scheme: 2 white - 2 black | ||
| + | |- | ||
| + | | class="op_enum_value" | '''2''' (Dashed) || Specifies line style with scheme: 3 white - 3 black | ||
| + | |- | ||
| + | | class="op_enum_value" | '''3''' (Dashed) || Specifies line style with scheme: 4 white - 4 black | ||
| + | |- | ||
| + | | class="op_enum_value" | '''4''' (Dashed) || Specifies line style with scheme: 4-3-2-3 | ||
| + | |- | ||
| + | | class="op_enum_value" | '''5''' (Dashed) || Specifies line style with scheme: 4-3-16-3 | ||
| + | |- | ||
| + | | class="op_enum_value" | '''6''' (Dashed) || Specifies line style with scheme: 8-4-4-4 | ||
| + | |} | ||
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Color | | class="op_param_name" | Color | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the color of the line. |
Default value: <tt>'''rgbd(0,0,0)'''</tt> | Default value: <tt>'''rgbd(0,0,0)'''</tt> | ||
|} | |} | ||
Latest revision as of 02:53, 22 March 2018
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) |
