Options
From PDF XChange PDF SDK
(Automatic page editing by robot) |
(→Options Table) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
{{#customTitle:Options}} | {{#customTitle:Options}} | ||
{{#parentPage:PXV:op_document_cropPages|Options|property}} | {{#parentPage:PXV:op_document_cropPages|Options|property}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| Line 14: | Line 13: | ||
| class="op_param_name" | IsOffset | | class="op_param_name" | IsOffset | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether to use given rectangles as offsets or as real rectangle coordinates on page. |
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 operation should be applied to. |
|- | |- | ||
| class="op_param_name" | [[PXV:cs_RectF|MediaBox]] | | class="op_param_name" | [[PXV:cs_RectF|MediaBox]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the media box coordinates or offsets. |
|- | |- | ||
| class="op_param_name" | [[PXV:cs_RectF|CropBox]] | | class="op_param_name" | [[PXV:cs_RectF|CropBox]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the crop box coordinates or offsets. |
|- | |- | ||
| class="op_param_name" | [[PXV:cs_RectF|TrimBox]] | | class="op_param_name" | [[PXV:cs_RectF|TrimBox]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the trim box coordinates or offsets. |
|- | |- | ||
| class="op_param_name" | [[PXV:cs_RectF|ArtBox]] | | class="op_param_name" | [[PXV:cs_RectF|ArtBox]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the art box coordinates or offsets. |
|- | |- | ||
| class="op_param_name" | [[PXV:cs_RectF|BleedBox]] | | class="op_param_name" | [[PXV:cs_RectF|BleedBox]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the bleed box coordinates or offsets. |
|- | |- | ||
| class="op_param_name" | Flags | | class="op_param_name" | Flags | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies... | + | | Specifies the flags for the operation. |
| + | {| class="op_internal_table" | ||
| + | |- | ||
| + | | class="op_enum_value" | '''0''' (None) || none of the boxes will be modified; | ||
| + | |- | ||
| + | | class="op_enum_value" | '''1''' (Media) || media box will be modified; | ||
| + | |- | ||
| + | | class="op_enum_value" | '''2''' (Crop) || crop box will be modified. | ||
| + | |- | ||
| + | | class="op_enum_value" | '''4''' (Trim) || trim box will be modified. | ||
| + | |- | ||
| + | | class="op_enum_value" | '''8''' (Art) || art box will be modified. | ||
| + | |- | ||
| + | | class="op_enum_value" | '''16''' (Bleed) || bleed box will be modified. | ||
| + | |- | ||
| + | | class="op_enum_value" | '''512''' (WithRedaction) || removes content outside of the crop box area. | ||
| + | |- | ||
| + | | class="op_enum_value" | '''1024''' (RemoveHorzWhiteSp) || the pages would be cropped by their content's bound box from top and bottom. Note that this flag is used remotely from all of the boxes flags, meaning that the boxes flags would be ignored. | ||
| + | |- | ||
| + | | class="op_enum_value" | '''2048''' (RemoveVertWhiteSp) || the pages would be cropped by their content's bound box from right and left. Note that this flag is used remotely from all of the boxes flags, meaning that the boxes flags would be ignored. | ||
| + | |- | ||
| + | | class="op_enum_value" | '''4096''' (MediaToCrop) || the media box size will be adjusted to match the crop box size. | ||
| + | |- | ||
| + | | class="op_enum_value" | '''8192''' (DontChangeBoxes) || corresponds to the Crop Method - None setting. | ||
| + | |- | ||
| + | | class="op_enum_value" | '''16384''' (RemoveAnnots) || removes annotations outside of the crop box area. | ||
| + | |- | ||
| + | | class="op_enum_value" | '''32768''' (RemoveFields) || removes fields outside of the crop box area. | ||
| + | |- | ||
| + | | class="op_enum_value" | '''65536''' (NormalizeMedia) || the media box will be changed to start from the (0;0). This will move all of the content, annotations and other boxes with correspondent offsets. This setting is only available when the MediaToCrop flag is being specified. | ||
| + | |} | ||
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|} | |} | ||
Latest revision as of 00:35, 29 June 2021
Options Table
| Name | Type | Value | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| IsOffset | Boolean | Specifies whether to use given rectangles as offsets or as real rectangle coordinates on page.
Default value: false | ||||||||||||||||||||||||||||
| PagesRange | Dictionary | Specifies the pages range which the operation should be applied to. | ||||||||||||||||||||||||||||
| MediaBox | Dictionary | Specifies the media box coordinates or offsets. | ||||||||||||||||||||||||||||
| CropBox | Dictionary | Specifies the crop box coordinates or offsets. | ||||||||||||||||||||||||||||
| TrimBox | Dictionary | Specifies the trim box coordinates or offsets. | ||||||||||||||||||||||||||||
| ArtBox | Dictionary | Specifies the art box coordinates or offsets. | ||||||||||||||||||||||||||||
| BleedBox | Dictionary | Specifies the bleed box coordinates or offsets. | ||||||||||||||||||||||||||||
| Flags | Integer | Specifies the flags for the operation.
Default value: 0 |
