PDFDestParams
From PDF XChange PDF SDK
| Line 2: | Line 2: | ||
{{#customTitle:PDFDestParams}} | {{#customTitle:PDFDestParams}} | ||
{{#parentPage:PXV:Params_CommonStructures|PDFDestParams|structure}} | {{#parentPage:PXV:Params_CommonStructures|PDFDestParams|structure}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| Line 26: | Line 25: | ||
| class="op_param_name" | NullFlags | | class="op_param_name" | NullFlags | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | | + | | Bit flags representing which '''v''' values should be used. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | v0 | | class="op_param_name" | v0 | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies value that corresponds to the first bit of the '''NullFlags'''. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | v1 | | class="op_param_name" | v1 | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies value that corresponds to the second bit of the '''NullFlags'''. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | v2 | | class="op_param_name" | v2 | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies value that corresponds to the third bit of the '''NullFlags'''. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | v3 | | class="op_param_name" | v3 | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies value that corresponds to the fourth bit of the '''NullFlags'''. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Name | | class="op_param_name" | Name | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the name of the named destination that will be used. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|} | |} | ||
Latest revision as of 04:46, 3 June 2015
Options Table
| Name | Type | Value |
|---|---|---|
| Page | Integer | Specifies the destination page number.
Default value: -1 |
| Type | Integer | Specifies the type of the destination.
The list of possible values are shown in the table. Default value: 0 (XYZ) |
| NullFlags | Integer | Bit flags representing which v values should be used.
Default value: -1 |
| v0 | Double | Specifies value that corresponds to the first bit of the NullFlags.
Default value: 0.0 |
| v1 | Double | Specifies value that corresponds to the second bit of the NullFlags.
Default value: 0.0 |
| v2 | Double | Specifies value that corresponds to the third bit of the NullFlags.
Default value: 0.0 |
| v3 | Double | Specifies value that corresponds to the fourth bit of the NullFlags.
Default value: 0.0 |
| Name | String | Specifies the name of the named destination that will be used.
Default value: Empty String |
See Also
op.annots.setProps, op.bookmarks.addNew, op.bookmarks.setProps, op.pdfNamedDests.insert, op.pdfNamedDests.set
