Options

From PDF XChange PDF SDK
Jump to: navigation, search
 
(47 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
[[Category:Editor]]
 
[[Category:Editor]]
{{#customTitle:Options of op.newBlankDoc Operation}}
+
{{#customTitle:Options}}
{{#parentPage:PXV:op_newBlankDoc|Options|Options}}
+
{{#parentPage:PXV:op_newBlankDoc|Options|property}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
== ==
+
== Options Table ==
 +
 
 +
{| class="wikitable op_options"
 +
! style="width:120pt;" | '''Name'''
 +
! style="width:60pt;" | '''Type'''
 +
! '''Value'''
 +
|-
 +
| class="op_param_name" | PaperType
 +
| style="text-align:center" | Integer
 +
| Specifies type of paper size that should be used for newly added pages. Possible values are:
 +
{| class="op_internal_table"
 +
|-
 +
| class="op_enum_value" | '''1''' (Standard) || The standard page size specified by <code>StdPaperIndex</code> parameter will be used.
 +
|-
 +
| class="op_enum_value" | '''2''' (Custom) || Page size specified by <code>Width</code>, and <code>Height</code> parameters will be used.
 +
|}
 +
Default value: <tt>'''1''' (Standard)</tt>
 +
|-
 +
| class="op_param_name" | Landscape
 +
| style="text-align:center" | Boolean
 +
| Specifies pages' orientation.
 +
 
 +
Default value: <tt>'''false'''</tt>
 +
|-
 +
| class="op_param_name" | StdPaperIndex
 +
| style="text-align:center" | Integer
 +
| Specifies one of standard predefined page size. The list of possible values are shown in [[PXV:Params_NamedValues_StandardPapers|the table]].
 +
|-
 +
| class="op_param_name" | Width
 +
| style="text-align:center" | Double
 +
| Specifies width of new pages in pt (1 pt = 1/72 in). The value should be in range from 3 to 14400. This parameter is used when <code>PaperType</code> has value of <tt>'''2''' (Custom)</tt>.
 +
 
 +
Default value: '''595.28''' (equivalent of 210 mm).
 +
|-
 +
| class="op_param_name" | Height
 +
| style="text-align:center" | Double
 +
| Specifies height of new pages in pt (1 pt = 1/72 in). The value should be in range from 3 to 14400. This parameter is used when <code>PaperType</code> has value of <tt>'''2''' (Custom)</tt>.
 +
 
 +
Default value: '''841.89''' (equivalent of 297 mm).
 +
|-
 +
| class="op_param_name" | Count
 +
| style="text-align:center" | Integer
 +
| Specifies a number of new pages that will be created.
 +
 
 +
Default value: '''1'''.
 +
|-
 +
| class="op_param_name" | Rotation
 +
| style="text-align:center" | Integer
 +
| Specifies rotation of newly added pages. The value must be an integer multiply of 90.
 +
 
 +
Default value: '''0'''.
 +
|}

Latest revision as of 00:36, 19 May 2018


Options Table

Name Type Value
PaperType Integer Specifies type of paper size that should be used for newly added pages. Possible values are:
1 (Standard) The standard page size specified by StdPaperIndex parameter will be used.
2 (Custom) Page size specified by Width, and Height parameters will be used.

Default value: 1 (Standard)

Landscape Boolean Specifies pages' orientation.

Default value: false

StdPaperIndex Integer Specifies one of standard predefined page size. The list of possible values are shown in the table.
Width Double Specifies width of new pages in pt (1 pt = 1/72 in). The value should be in range from 3 to 14400. This parameter is used when PaperType has value of 2 (Custom).

Default value: 595.28 (equivalent of 210 mm).

Height Double Specifies height of new pages in pt (1 pt = 1/72 in). The value should be in range from 3 to 14400. This parameter is used when PaperType has value of 2 (Custom).

Default value: 841.89 (equivalent of 297 mm).

Count Integer Specifies a number of new pages that will be created.

Default value: 1.

Rotation Integer Specifies rotation of newly added pages. The value must be an integer multiply of 90.

Default value: 0.