op.document.addHeaderAndFooter

From PDF XChange PDF SDK
Jump to: navigation, search
(Sample)
 
(One intermediate revision by the same user not shown)
Line 25: Line 25:
 
| Dictionary with options of the operation.
 
| Dictionary with options of the operation.
 
|}
 
|}
 +
 +
== Sample ==
 +
<pre class="brush:c#">//C#
 +
private void AddHeaderFooter(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
 +
{
 +
int nID = Inst.Str2ID("op.document.addHeaderAndFooter", false);
 +
PDFXEdit.IOperation Op = Inst.CreateOp(nID);
 +
var input = Op.Params.Root["Input"];
 +
input.v = Doc.CoreDoc;
 +
PDFXEdit.ICabNode options = Op.Params.Root["Options"];
 +
options["PagesRange.Type"].v = "All";
 +
options["CenterHeaderText"].v = "Central Header Text";
 +
options["RightFooterText"].v = "<<1 of n>>";
 +
options["Font.Size"].v = 42;
 +
Op.Do();
 +
}
 +
</pre>

Latest revision as of 00:51, 14 November 2016


Overview

The operation allows to add headers and footers to the document.

Parameters

Name Type Description
Input IUnknown IUnknown-based object containing the IPXC_Document which the headers and footers will be added to.
Output IUnknown IUnknown-based object containing the IPXC_Document with added headers and footers. Not yet implemented.
Options Dictionary Dictionary with options of the operation.

Sample

//C#
private void AddHeaderFooter(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
{
	int nID = Inst.Str2ID("op.document.addHeaderAndFooter", false);
	PDFXEdit.IOperation Op = Inst.CreateOp(nID);
	var input = Op.Params.Root["Input"];
	input.v = Doc.CoreDoc;
	PDFXEdit.ICabNode options = Op.Params.Root["Options"];
	options["PagesRange.Type"].v = "All";
	options["CenterHeaderText"].v = "Central Header Text";
	options["RightFooterText"].v = "<<1 of n>>";
	options["Font.Size"].v = 42;
	Op.Do();
}