Options

From PDF XChange PDF SDK
Jump to: navigation, search
(Label ToWrite removed)
Line 2: Line 2:
 
{{#customTitle:Options}}
 
{{#customTitle:Options}}
 
{{#parentPage:PXV:op_newBlankDoc|Options|property}}
 
{{#parentPage:PXV:op_newBlankDoc|Options|property}}
 
 
{{ToReview}}
 
{{ToReview}}
  
Line 17: Line 16:
 
{| class="op_internal_table"
 
{| class="op_internal_table"
 
|-
 
|-
| class="op_enum_value" | '''0''' (Document) || use size of first page of the document;
+
| class="op_enum_value" | '''0''' (Document) || The size of the first page of the document will be used.
 
|-
 
|-
| class="op_enum_value" | '''1''' (Standard) || use standard page size specified by <code>StdPaperIndex</code> parameter;
+
| 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) || use page size specified by <code>Width</code>, and <code>Height</code> parameters.
+
| 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>
 
Default value: <tt>'''1''' (Standard)</tt>
Line 27: Line 26:
 
| class="op_param_name" | Landscape
 
| class="op_param_name" | Landscape
 
| style="text-align:center" | Boolean
 
| style="text-align:center" | Boolean
| Specifies orientation of the page.
+
| Specifies pages' orientation.
  
 
Default value: <tt>'''false'''</tt>
 
Default value: <tt>'''false'''</tt>
Line 49: Line 48:
 
| class="op_param_name" | Count
 
| class="op_param_name" | Count
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies a number of new pages to be created.
+
| Specifies a number of new pages that will be created.
  
 
Default value: '''1'''.
 
Default value: '''1'''.

Revision as of 02:10, 15 March 2016


Options Table

Name Type Value
PaperType Integer Specifies type of paper size that should be used for newly added pages. Possible values are:
0 (Document) The size of the first page of the document will be used.
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.