op.attachments.edit

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
(Sample)
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{#customTitle:op.attachments.edit}}
 
{{#customTitle:op.attachments.edit}}
 
{{#parentPage:PXV:Operations|op.attachments.edit|operation}}
 
{{#parentPage:PXV:Operations|op.attachments.edit|operation}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
 
== Overview ==
 
== Overview ==
The operation overview...
+
The operation allows to edit the description of the attachment.
  
 
== Parameters ==
 
== Parameters ==
Line 16: Line 15:
 
| class="op_param_name" | Input
 
| class="op_param_name" | Input
 
| style="text-align:center" | Array
 
| style="text-align:center" | Array
| Array of <code>IUnknown</code>-based objects.
+
| Array of <code>IUnknown</code>-based objects that should contain the [[PXV:IPXC_Document|IPXC_Document]] that contains the attachment that would be edited. Note that only the first element from the array will be evaluated.
 
|-
 
|-
 
| 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.
+
| Array of <code>IUnknown</code>-based objects containing the [[PXV:IPXC_Document|IPXC_Document]] which attachment was modified.
 
|-
 
|-
 
| class="op_param_name" | [[PXV:op_attachments_edit_Options|Options]]
 
| class="op_param_name" | [[PXV:op_attachments_edit_Options|Options]]
Line 26: Line 25:
 
| Dictionary with options of the operation.
 
| Dictionary with options of the operation.
 
|}
 
|}
 +
 +
== Sample ==
 +
<pre class="brush:c#">//C#
 +
private void EditAttachmentDescription(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
 +
{
 +
int nID = Inst.Str2ID("op.attachments.edit", 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.IPXC_NameTree Tree = Doc.CoreDoc.GetNameTree("EmbeddedFiles");
 +
PDFXEdit.IAFS_Inst fsInst = (PDFXEdit.IAFS_Inst)Inst.GetExtension("AFS");
 +
PDFXEdit.IAFS_FileSys pFSys = fsInst.DefaultFileSys;
 +
string sName;
 +
uint nAttachmentsCount = Tree.Count;
 +
if (nAttachmentsCount == 0)
 +
return;
 +
PDFXEdit.IPXS_PDFVariant pValue;
 +
//Getting first attachment
 +
Tree.Item(0, out sName, out pValue);
 +
PDFXEdit.IPXC_FileSpec FS = Doc.CoreDoc.GetFileSpecFromVariant(pValue);
 +
options["Attachment"].v = FS;
 +
options["Description"].v = "Fist attachment's description";
 +
Op.Do();
 +
}
 +
</pre>

Latest revision as of 00:06, 21 April 2016


Overview

The operation allows to edit the description of the attachment.

Parameters

Name Type Description
Input Array Array of IUnknown-based objects that should contain the IPXC_Document that contains the attachment that would be edited. Note that only the first element from the array will be evaluated.
Output Array Array of IUnknown-based objects containing the IPXC_Document which attachment was modified.
Options Dictionary Dictionary with options of the operation.

Sample

//C#
private void EditAttachmentDescription(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
{
	int nID = Inst.Str2ID("op.attachments.edit", 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.IPXC_NameTree Tree = Doc.CoreDoc.GetNameTree("EmbeddedFiles");
	PDFXEdit.IAFS_Inst fsInst = (PDFXEdit.IAFS_Inst)Inst.GetExtension("AFS");
	PDFXEdit.IAFS_FileSys pFSys = fsInst.DefaultFileSys;
	string sName;
	uint nAttachmentsCount = Tree.Count;
	if (nAttachmentsCount == 0)
		return;
	PDFXEdit.IPXS_PDFVariant pValue;
	//Getting first attachment
	Tree.Item(0, out sName, out pValue);
	PDFXEdit.IPXC_FileSpec FS = Doc.CoreDoc.GetFileSpecFromVariant(pValue);
	options["Attachment"].v = FS;
	options["Description"].v = "Fist attachment's description";
	Op.Do();
}