Options
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| Line 14: | Line 14: | ||
| class="op_param_name" | PaperType | | class="op_param_name" | PaperType | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the type of paper that would be used for page dimensions. |
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) || The page size would be the same as document's. |
|- | |- | ||
| − | | class="op_enum_value" | '''1''' (Standard) || | + | | class="op_enum_value" | '''1''' (Standard) || The page size value would be taken from the standard values table. |
|- | |- | ||
| − | | class="op_enum_value" | '''2''' (Custom) || | + | | class="op_enum_value" | '''2''' (Custom) || The page size would be custom. |
|- | |- | ||
| − | | class="op_enum_value" | '''3''' (BySource) || | + | | class="op_enum_value" | '''3''' (BySource) || The page size would be taken from the source file. |
|} | |} | ||
Default value: <tt>'''1''' (Standard)</tt> | Default value: <tt>'''1''' (Standard)</tt> | ||
| Line 30: | Line 30: | ||
| class="op_param_name" | StdPaperIndex | | class="op_param_name" | StdPaperIndex | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the index in the standard papers table. |
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 37: | Line 37: | ||
| class="op_param_name" | Width | | class="op_param_name" | Width | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the custom width of the page. |
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 | ||
| − | | Specifies | + | | Specifies the custom height of the page. |
Default value: <tt>'''841.89'''</tt> | Default value: <tt>'''841.89'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Landscape | | class="op_param_name" | Landscape | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the page should have portrait or landscape orientation. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | HOffset | | class="op_param_name" | HOffset | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the horizontal offset of the pages media box. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | VOffset | | class="op_param_name" | VOffset | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the vertical offset of the pages media box. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | VOffsetFrom | | class="op_param_name" | VOffsetFrom | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies where from the vertical offset would be taken. |
The list of possible values are shown in [[PXV:Params_NamedValues_WatermarkOffsetOrigins|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_WatermarkOffsetOrigins|the table]]. | ||
| Line 69: | Line 69: | ||
| class="op_param_name" | HOffsetFrom | | class="op_param_name" | HOffsetFrom | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies where from the horizontal offset would be taken. |
The list of possible values are shown in [[PXV:Params_NamedValues_WatermarkOffsetOrigins|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_WatermarkOffsetOrigins|the table]]. | ||
| Line 76: | Line 76: | ||
| class="op_param_name" | ScalePage | | class="op_param_name" | ScalePage | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the content should be scaled with pages. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | ConstraintProportions | | class="op_param_name" | ConstraintProportions | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the content should constraint proportion when the page dimensions change. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[PXV:cs_PagesRange|PagesRange]] | | class="op_param_name" | [[PXV:cs_PagesRange|PagesRange]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the pages range which the page resizing should be applied to. |
|} | |} | ||
Revision as of 01:50, 29 May 2015
Options Table
| Name | Type | Value | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| PaperType | Integer | Specifies the type of paper that would be used for page dimensions.
Possible values are:
Default value: 1 (Standard) | ||||||||
| StdPaperIndex | Integer | Specifies the index in the standard papers table.
The list of possible values are shown in the table. Default value: 4 (A4) | ||||||||
| Width | Double | Specifies the custom width of the page.
Default value: 595.276 | ||||||||
| Height | Double | Specifies the custom height of the page.
Default value: 841.89 | ||||||||
| Landscape | Boolean | Specifies whether the page should have portrait or landscape orientation.
Default value: false | ||||||||
| HOffset | Double | Specifies the horizontal offset of the pages media box.
Default value: 0.0 | ||||||||
| VOffset | Double | Specifies the vertical offset of the pages media box.
Default value: 0.0 | ||||||||
| VOffsetFrom | Integer | Specifies where from the vertical offset would be taken.
The list of possible values are shown in the table. Default value: 1 (Center) | ||||||||
| HOffsetFrom | Integer | Specifies where from the horizontal offset would be taken.
The list of possible values are shown in the table. Default value: 1 (Center) | ||||||||
| ScalePage | Boolean | Specifies whether the content should be scaled with pages.
Default value: false | ||||||||
| ConstraintProportions | Boolean | Specifies whether the content should constraint proportion when the page dimensions change.
Default value: false | ||||||||
| PagesRange | Dictionary | Specifies the pages range which the page resizing should be applied to. |
