op.bookmarks.setProps
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
(One intermediate revision by the same user not shown) | |||
Line 2: | Line 2: | ||
{{#customTitle:op.bookmarks.setProps}} | {{#customTitle:op.bookmarks.setProps}} | ||
{{#parentPage:PXV:Operations|op.bookmarks.setProps|operation}} | {{#parentPage:PXV:Operations|op.bookmarks.setProps|operation}} | ||
− | |||
{{ToReview}} | {{ToReview}} | ||
== Overview == | == Overview == | ||
− | The operation | + | The operation allows to modify the bookmarks' properties. |
== Parameters == | == Parameters == | ||
Line 16: | Line 15: | ||
| class="op_param_name" | Input | | class="op_param_name" | Input | ||
| style="text-align:center" | Array | | style="text-align:center" | Array | ||
− | | Array of <code>IUnknown</code>-based objects. | + | | Array of <code>IUnknown</code>-based objects containing the [[PXV:IPXC_Bookmark|IPXC_Bookmark]] objects that need to be modified or the [[PXV:IPXC_Document|IPXC_Document]] object when all of the bookmarks must be modified. Note that all of the bookmarks must belong to one document. |
|- | |- | ||
| class="op_param_name" | Output | | class="op_param_name" | Output | ||
| style="text-align:center;" | Array | | style="text-align:center;" | Array | ||
− | | Array of <code>IUnknown</code>-based objects. | + | | Array of <code>IUnknown</code>-based objects containing the [[PXV:IPXC_Document|IPXC_Document]] from which the bookmarks were modified. |
|- | |- | ||
| class="op_param_name" | [[PXV:op_bookmarks_setProps_Options|Options]] | | class="op_param_name" | [[PXV:op_bookmarks_setProps_Options|Options]] | ||
Line 26: | Line 25: | ||
| Dictionary with options of the operation. | | Dictionary with options of the operation. | ||
|} | |} | ||
+ | |||
+ | == Sample == | ||
+ | <pre class="brush:c#">//C# | ||
+ | private void SetBookmarksTitle(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst) | ||
+ | { | ||
+ | int nID = Inst.Str2ID("op.bookmarks.setProps", false); | ||
+ | PDFXEdit.IOperation Op = Inst.CreateOp(nID); | ||
+ | PDFXEdit.ICabNode input = Op.Params.Root["Input"]; | ||
+ | input.Add().v = Doc.CoreDoc; //Select all of the bookmarks in document | ||
+ | PDFXEdit.ICabNode options = Op.Params.Root["Options"]; | ||
+ | options["Mask"].v = 1; //Set edit title mask | ||
+ | options["Title"].v = "Bkm";//New title | ||
+ | Op.Do(); | ||
+ | } | ||
+ | |||
+ | private void SetBookmarksStyle(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst) | ||
+ | { | ||
+ | int nID = Inst.Str2ID("op.bookmarks.setProps", false); | ||
+ | PDFXEdit.IOperation Op = Inst.CreateOp(nID); | ||
+ | PDFXEdit.ICabNode input = Op.Params.Root["Input"]; | ||
+ | input.Add().v = Doc.CoreDoc; | ||
+ | PDFXEdit.ICabNode options = Op.Params.Root["Options"]; | ||
+ | options["Mask"].v = 2; //Set edit style mask | ||
+ | options["Style"].v = 2;//Change style to bold | ||
+ | Op.Do(); | ||
+ | } | ||
+ | </pre> |
Latest revision as of 05:58, 18 April 2016
Overview
The operation allows to modify the bookmarks' properties.
Parameters
Name | Type | Description |
---|---|---|
Input | Array | Array of IUnknown -based objects containing the IPXC_Bookmark objects that need to be modified or the IPXC_Document object when all of the bookmarks must be modified. Note that all of the bookmarks must belong to one document.
|
Output | Array | Array of IUnknown -based objects containing the IPXC_Document from which the bookmarks were modified.
|
Options | Dictionary | Dictionary with options of the operation. |
Sample
//C# private void SetBookmarksTitle(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst) { int nID = Inst.Str2ID("op.bookmarks.setProps", false); PDFXEdit.IOperation Op = Inst.CreateOp(nID); PDFXEdit.ICabNode input = Op.Params.Root["Input"]; input.Add().v = Doc.CoreDoc; //Select all of the bookmarks in document PDFXEdit.ICabNode options = Op.Params.Root["Options"]; options["Mask"].v = 1; //Set edit title mask options["Title"].v = "Bkm";//New title Op.Do(); } private void SetBookmarksStyle(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst) { int nID = Inst.Str2ID("op.bookmarks.setProps", false); PDFXEdit.IOperation Op = Inst.CreateOp(nID); PDFXEdit.ICabNode input = Op.Params.Root["Input"]; input.Add().v = Doc.CoreDoc; PDFXEdit.ICabNode options = Op.Params.Root["Options"]; options["Mask"].v = 2; //Set edit style mask options["Style"].v = 2;//Change style to bold Op.Do(); }