op.document.addBackground

PDF Editor Layer > Operations > op.document.addBackground

Overview

The operation allows to add background to the document.

Parameters

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

Sample

//C#
private void AddBackground(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
{
	int nID = Inst.Str2ID("op.document.addBackground", 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["Type"].v = 0; //Color
	PDFXEdit.IAUX_Inst aInst = (PDFXEdit.IAUX_Inst)Inst.GetExtension("AUX");
	PDFXEdit.IColor clr = aInst.CreateColor(PDFXEdit.ColorType.ColorType_RGB);
	clr.SetRGB(1.0f, 0.0f, 1.0f);
	options["Color"].v = clr.Value; //Color
	Op.Do();
}