op.pdfNamedDests.delete

From Tracker Software PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{#customTitle:op.pdfNamedDests.delete}}
 
{{#customTitle:op.pdfNamedDests.delete}}
 
{{#parentPage:PXV:Operations|op.pdfNamedDests.delete|operation}}
 
{{#parentPage:PXV:Operations|op.pdfNamedDests.delete|operation}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
 
== Overview ==
 
== Overview ==
The operation overview...
+
The operation allows to remove named destinations from the document.
  
 
== 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]] which the named destinations would be deleted from. 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 the named destinations were deleted from.
 
|-
 
|-
 
| class="op_param_name" | [[PXV:op_pdfNamedDests_delete_Options|Options]]
 
| class="op_param_name" | [[PXV:op_pdfNamedDests_delete_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 DeleteAllNamedDestinations(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
 +
{
 +
int nID = Inst.Str2ID("op.pdfNamedDests.delete", false);
 +
PDFXEdit.IOperation Op = Inst.CreateOp(nID);
 +
var input = Op.Params.Root["Input"];
 +
input.Add().v = Doc.CoreDoc;
 +
PDFXEdit.ICabNode options = Op.Params.Root["Options"];
 +
PDFXEdit.IAUX_Inst auxInst = (PDFXEdit.IAUX_Inst)Inst.GetExtension("AUX");
 +
PDFXEdit.IUniqueStrings US = auxInst.CreateUniqueStringsList();
 +
PDFXEdit.IPXC_NameTree Tree = Doc.CoreDoc.GetNameTree("Dests");
 +
for (uint i = 0; i < Tree.Count; i++)
 +
{
 +
US.Insert(Tree.get_ItemName(i));
 +
}
 +
options["Names"].v = US;
 +
Op.Do();
 +
}
 +
</pre>

Latest revision as of 06:10, 21 April 2016


Overview

The operation allows to remove named destinations from the document.

Parameters

Name Type Description
Input Array Array of IUnknown-based objects that should contain the IPXC_Document which the named destinations would be deleted from. Note that only the first element from the array will be evaluated.
Output Array Array of IUnknown-based objects containing the IPXC_Document which the named destinations were deleted from.
Options Dictionary Dictionary with options of the operation.

Sample

//C#
private void DeleteAllNamedDestinations(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
{
	int nID = Inst.Str2ID("op.pdfNamedDests.delete", false);
	PDFXEdit.IOperation Op = Inst.CreateOp(nID);
	var input = Op.Params.Root["Input"];
	input.Add().v = Doc.CoreDoc;
	PDFXEdit.ICabNode options = Op.Params.Root["Options"];
	PDFXEdit.IAUX_Inst auxInst = (PDFXEdit.IAUX_Inst)Inst.GetExtension("AUX");
	PDFXEdit.IUniqueStrings US = auxInst.CreateUniqueStringsList();
	PDFXEdit.IPXC_NameTree Tree = Doc.CoreDoc.GetNameTree("Dests");
	for (uint i = 0; i < Tree.Count; i++)
	{
		US.Insert(Tree.get_ItemName(i));
	}
	options["Names"].v = US;
	Op.Do();
}