op.bookmarks.delete

From PDF XChange PDF SDK
Jump to: navigation, search
 
Line 21: Line 21:
 
| Array of <code>IUnknown</code>-based objects containing the [[PXV:IPXC_Document|IPXC_Document]] from which the bookmarks were deleted.
 
| 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();
}