op.bookmarks.delete
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.delete}} | {{#customTitle:op.bookmarks.delete}} | ||
{{#parentPage:PXV:Operations|op.bookmarks.delete|operation}} | {{#parentPage:PXV:Operations|op.bookmarks.delete|operation}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
== Overview == | == Overview == | ||
| − | The operation | + | The operation allows to delete given bookmarks from 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 containing the [[PXV:IPXC_Bookmark|IPXC_Bookmark]] objects that need to be deleted or the [[PXV:IPXC_Document|IPXC_Document]] object when all of the bookmarks must be removed from it. 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 deleted. |
|} | |} | ||
| + | |||
| + | == Sample == | ||
| + | <pre class="brush:c#">//C# | ||
| + | private void DeleteBookmarks(PDFXEdit.IPXV_Document Doc, PDFXEdit.PXV_Inst Inst) | ||
| + | { | ||
| + | int nID = Inst.Str2ID("op.bookmarks.delete", false); | ||
| + | PDFXEdit.IOperation Op = Inst.CreateOp(nID); | ||
| + | PDFXEdit.ICabNode input = Op.Params.Root["Input"]; | ||
| + | //Adding first root bookmark from the Bookmarks Tree | ||
| + | input.Add().v = Doc.CoreDoc.BookmarkRoot.FirstChild; | ||
| + | Op.Do(); | ||
| + | } | ||
| + | </pre> | ||
Latest revision as of 05:43, 18 April 2016
Overview
The operation allows to delete given bookmarks from the document.
Parameters
| Name | Type | Description |
|---|---|---|
| Input | Array | Array of IUnknown-based objects containing the IPXC_Bookmark objects that need to be deleted or the IPXC_Document object when all of the bookmarks must be removed from it. 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 deleted.
|
Sample
//C#
private void DeleteBookmarks(PDFXEdit.IPXV_Document Doc, PDFXEdit.PXV_Inst Inst)
{
int nID = Inst.Str2ID("op.bookmarks.delete", false);
PDFXEdit.IOperation Op = Inst.CreateOp(nID);
PDFXEdit.ICabNode input = Op.Params.Root["Input"];
//Adding first root bookmark from the Bookmarks Tree
input.Add().v = Doc.CoreDoc.BookmarkRoot.FirstChild;
Op.Do();
}
