op.pdfNamedDests.set
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 2: | Line 2: | ||
{{#customTitle:op.pdfNamedDests.set}} | {{#customTitle:op.pdfNamedDests.set}} | ||
{{#parentPage:PXV:Operations|op.pdfNamedDests.set|operation}} | {{#parentPage:PXV:Operations|op.pdfNamedDests.set|operation}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
== Overview == | == Overview == | ||
| − | The operation | + | The operation allows to change where the named destination will point to. |
== 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]] with the named destination that needs to be set. 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]] with newly set named destination. |
|- | |- | ||
| class="op_param_name" | [[PXV:op_pdfNamedDests_set_Options|Options]] | | class="op_param_name" | [[PXV:op_pdfNamedDests_set_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 SetNamedDestination(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst) | ||
| + | { | ||
| + | int nID = Inst.Str2ID("op.pdfNamedDests.set", false); | ||
| + | PDFXEdit.IOperation Op = Inst.CreateOp(nID); | ||
| + | var input = Op.Params.Root["Input"]; | ||
| + | input.v = Doc.CoreDoc; | ||
| + | PDFXEdit.ICabNode options = Op.Params.Root["Options"]; | ||
| + | PDFXEdit.IPXC_NameTree Tree = Doc.CoreDoc.GetNameTree("Dests"); | ||
| + | if (Tree.Count > 0) | ||
| + | { | ||
| + | options["Name"].v = Tree.get_ItemName(0); | ||
| + | PDFXEdit.ICabNode dest = options["Dest"]; | ||
| + | dest["Page"].v = 0; | ||
| + | Op.Do(); | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
Latest revision as of 07:24, 21 April 2016
Overview
The operation allows to change where the named destination will point to.
Parameters
| Name | Type | Description |
|---|---|---|
| Input | Array | Array of IUnknown-based objects that should contain the IPXC_Document with the named destination that needs to be set. Note that only the first element from the array will be evaluated.
|
| Output | Array | Array of IUnknown-based objects containing the IPXC_Document with newly set named destination.
|
| Options | Dictionary | Dictionary with options of the operation. |
Sample
//C#
private void SetNamedDestination(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
{
int nID = Inst.Str2ID("op.pdfNamedDests.set", false);
PDFXEdit.IOperation Op = Inst.CreateOp(nID);
var input = Op.Params.Root["Input"];
input.v = Doc.CoreDoc;
PDFXEdit.ICabNode options = Op.Params.Root["Options"];
PDFXEdit.IPXC_NameTree Tree = Doc.CoreDoc.GetNameTree("Dests");
if (Tree.Count > 0)
{
options["Name"].v = Tree.get_ItemName(0);
PDFXEdit.ICabNode dest = options["Dest"];
dest["Page"].v = 0;
Op.Do();
}
}
