op.bookmarks.addNew
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
{{#customTitle:op.bookmarks.addNew}} | {{#customTitle:op.bookmarks.addNew}} | ||
{{#parentPage:PXV:Operations|op.bookmarks.addNew|operation}} | {{#parentPage:PXV:Operations|op.bookmarks.addNew|operation}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
== Overview == | == Overview == | ||
| − | The operation | + | The operation allows to add new bookmark with given properties to the document. |
== 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 that should contain the [[PXV:IPXC_Document|IPXC_Document]] to which the bookmark will be added. Note that only the first element from the array will be evaluated. |
|- | |- | ||
| 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_Bookmark|IPXC_Bookmark]]. |
|- | |- | ||
| class="op_param_name" | [[PXV:op_bookmarks_addNew_Options|Options]] | | class="op_param_name" | [[PXV:op_bookmarks_addNew_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 AddBookmark(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst) | ||
| + | { | ||
| + | int nID = Inst.Str2ID("op.bookmarks.addNew", false); | ||
| + | PDFXEdit.IOperation Op = Inst.CreateOp(nID); | ||
| + | PDFXEdit.ICabNode input = Op.Params.Root["Input"]; | ||
| + | input.Add().v = Doc; | ||
| + | PDFXEdit.ICabNode options = Op.Params.Root["Options"]; | ||
| + | PDFXEdit.IPXC_ActionsList AL = Doc.CoreDoc.CreateActionsList(); | ||
| + | PDFXEdit.PXC_Destination dest = new PDFXEdit.PXC_Destination(); | ||
| + | dest.nPageNum = 0; | ||
| + | dest.nNullFlags = 15; | ||
| + | dest.nType = PDFXEdit.PXC_DestType.Dest_XYZ; | ||
| + | AL.AddGoto(dest); | ||
| + | options["Title"].v = "Your Title"; | ||
| + | options["Color"].v = "rgbd(100,100,100)"; | ||
| + | options["Style"].v = 1;// Italic style for bookmark | ||
| + | options["Actions"].v = AL; | ||
| + | Op.Do(); | ||
| + | } | ||
| + | </pre> | ||
Latest revision as of 04:50, 18 April 2016
Overview
The operation allows to add new bookmark with given properties to the document.
Parameters
| Name | Type | Description |
|---|---|---|
| Input | Array | Array of IUnknown-based objects that should contain the IPXC_Document to which the bookmark will be added. Note that only the first element from the array will be evaluated.
|
| Output | Array | Array of IUnknown-based objects containing the IPXC_Bookmark.
|
| Options | Dictionary | Dictionary with options of the operation. |
Sample
//C#
private void AddBookmark(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
{
int nID = Inst.Str2ID("op.bookmarks.addNew", false);
PDFXEdit.IOperation Op = Inst.CreateOp(nID);
PDFXEdit.ICabNode input = Op.Params.Root["Input"];
input.Add().v = Doc;
PDFXEdit.ICabNode options = Op.Params.Root["Options"];
PDFXEdit.IPXC_ActionsList AL = Doc.CoreDoc.CreateActionsList();
PDFXEdit.PXC_Destination dest = new PDFXEdit.PXC_Destination();
dest.nPageNum = 0;
dest.nNullFlags = 15;
dest.nType = PDFXEdit.PXC_DestType.Dest_XYZ;
AL.AddGoto(dest);
options["Title"].v = "Your Title";
options["Color"].v = "rgbd(100,100,100)";
options["Style"].v = 1;// Italic style for bookmark
options["Actions"].v = AL;
Op.Do();
}
