View source for PXV:op document addImage

[[Category:Editor]]
{{#customTitle:op.document.addImage}}
{{#parentPage:PXV:Operations|op.document.addImage|operation}}
{{ToReview}}

== Overview ==
The operation allows to place an image onto document's page as a part of the page's content or as stamp.

== Parameters ==
{| class="wikitable operation"
! style="width:60pt;" | '''Name'''
! style="width:60pt;" | '''Type'''
! '''Description'''
|-
| class="op_param_name" | Input
| style="text-align:center" | Array
| <code>IUnknown</code>-based object containing the [[PXV:IPXC_Document|IPXC_Document]] where the image would be placed at.
|-
| class="op_param_name" | Output
| style="text-align:center;" | Array
| <code>IUnknown</code>-based object containing the [[PXV:IPXC_Annotation|IPXC_Annotation]] when adding image as stamp or the [[PXV:INumArray|INumArray]] when adding image as content.
|-
| class="op_param_name" | [[PXV:op_document_addImage_Options|Options]]
| style="text-align:center;" | Dictionary
| Dictionary with options of the operation.
|}

== Sample ==
<pre class="brush:c#">//C#
private void AddImageToFirstPage(PDFXEdit.IPXV_Document Doc, PDFXEdit.PXV_Inst Inst)
{
	if (Doc == null)
		return;
	int nID = Inst.Str2ID("op.document.addImage", false);
	PDFXEdit.IOperation pOp = Inst.CreateOp(nID);
	PDFXEdit.ICabNode input = pOp.Params.Root["Input"];
	input.v = Doc;
	PDFXEdit.ICabNode options = pOp.Params.Root["Options"];
	options["Page"].v = 0;	//First page
	options["Pos.top"].v = 400;
	options["Pos.left"].v = 50;
	options["Pos.right"].v = 400;
	options["Pos.bottom"].v = 50;
	options["AlignMode"].v = 1 | 4; //Horizontal and vertical center
	options["AsStamp"].v = false; //Inserting as a part of the content
	PDFXEdit.IAFS_Inst fsInst = (PDFXEdit.IAFS_Inst)Inst.GetExtension("AFS");
	PDFXEdit.IAFS_Name destPath = fsInst.DefaultFileSys.StringToName("D:\\TestImage.png"); //Converting string to name
	options["Src"].v = destPath;
	pOp.Do();
}
</pre>