op.bookmarks.setProps

From PDF XChange PDF SDK
Jump to: navigation, search
 
Line 25: 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();
}