op.attachments.addMulti

From PDF XChange PDF SDK
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 19: Line 19:
 
| class="op_param_name" | Output
 
| class="op_param_name" | Output
 
| style="text-align:center;" | Array
 
| style="text-align:center;" | Array
| Array of <code>IUnknown</code>-based objects containing the newly created [[PXV:IPXC_FileSpec|IPXC_FileSpec]].
+
| Array of <code>IUnknown</code>-based objects containing the newly created [[PXV:IPXC_FileSpec|IPXC_FileSpec]] objects.
 
|-
 
|-
 
| class="op_param_name" | [[PXV:op_attachments_addMulti_Options|Options]]
 
| class="op_param_name" | [[PXV:op_attachments_addMulti_Options|Options]]
Line 25: Line 25:
 
| Dictionary with options of the operation.
 
| Dictionary with options of the operation.
 
|}
 
|}
 +
 +
== Sample ==
 +
<pre class="brush:c#">//C#
 +
private void AddAttachments(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
 +
{
 +
int nID = Inst.Str2ID("op.attachments.addMulti", false);
 +
PDFXEdit.IOperation Op = Inst.CreateOp(nID);
 +
PDFXEdit.ICabNode input = Op.Params.Root["Input"];
 +
input.Add().v = Doc;
 +
PDFXEdit.ICabNode options = Op.Params.Root["Options"];
 +
PDFXEdit.IAFS_Inst fsInst = (PDFXEdit.IAFS_Inst)Inst.GetExtension("AFS");
 +
PDFXEdit.IAFS_NamesCollection fileNames = fsInst.CreateNames();
 +
PDFXEdit.IAFS_Name destPath = fsInst.DefaultFileSys.StringToName("D:\\TestImage.png"); //Converting string to name
 +
fileNames.Add(destPath);
 +
destPath = fsInst.DefaultFileSys.StringToName("D:\\TestFile.pdf"); //Converting string to name
 +
fileNames.Add(destPath);
 +
options["FileNamesCollection"].v = fileNames;
 +
Op.Do();
 +
}
 +
</pre>

Latest revision as of 07:47, 15 April 2016


Overview

The operation allows to add multiple file attachments to the document.

Parameters

Name Type Description
Input Array Array of IUnknown-based objects that should contain the IPXC_Document to which the attachments should be added. Note that only the first element from the array will be evaluated.
Output Array Array of IUnknown-based objects containing the newly created IPXC_FileSpec objects.
Options Dictionary Dictionary with options of the operation.

Sample

//C#
private void AddAttachments(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
{
	int nID = Inst.Str2ID("op.attachments.addMulti", false);
	PDFXEdit.IOperation Op = Inst.CreateOp(nID);
	PDFXEdit.ICabNode input = Op.Params.Root["Input"];
	input.Add().v = Doc;
	PDFXEdit.ICabNode options = Op.Params.Root["Options"];
	PDFXEdit.IAFS_Inst fsInst = (PDFXEdit.IAFS_Inst)Inst.GetExtension("AFS");
	PDFXEdit.IAFS_NamesCollection fileNames = fsInst.CreateNames();
	PDFXEdit.IAFS_Name destPath = fsInst.DefaultFileSys.StringToName("D:\\TestImage.png"); //Converting string to name
	fileNames.Add(destPath);
	destPath = fsInst.DefaultFileSys.StringToName("D:\\TestFile.pdf"); //Converting string to name
	fileNames.Add(destPath);
	options["FileNamesCollection"].v = fileNames;
	Op.Do();
}