op.pdfNamedDests.insert

From Tracker Software PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
 
{{#customTitle:op.pdfNamedDests.insert}}
 
{{#customTitle:op.pdfNamedDests.insert}}
 
{{#parentPage:PXV:Operations|op.pdfNamedDests.insert|operation}}
 
{{#parentPage:PXV:Operations|op.pdfNamedDests.insert|operation}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
 
== Overview ==
 
== Overview ==
The operation overview...
+
The operation allows inserting new named destinations into 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 inserted into. 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 inserted into.
 
|-
 
|-
 
| class="op_param_name" | [[PXV:op_pdfNamedDests_insert_Options|Options]]
 
| class="op_param_name" | [[PXV:op_pdfNamedDests_insert_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 InsertNamedDestination(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
 +
{
 +
int nID = Inst.Str2ID("op.pdfNamedDests.insert", 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"];
 +
options["Name"].v = "New Named Destination";
 +
PDFXEdit.ICabNode dest = options["Dest"];
 +
dest["Page"].v = 0;
 +
Op.Do();
 +
}
 +
</pre>

Latest revision as of 07:16, 21 April 2016


Overview

The operation allows inserting new named destinations into 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 inserted into. 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 inserted into.
Options Dictionary Dictionary with options of the operation.

Sample

//C#
private void InsertNamedDestination(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
{
	int nID = Inst.Str2ID("op.pdfNamedDests.insert", 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"];
	options["Name"].v = "New Named Destination";
	PDFXEdit.ICabNode dest = options["Dest"];
	dest["Page"].v = 0;
	Op.Do();
}