op.resetForm
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
{{#customTitle:op.resetForm}} | {{#customTitle:op.resetForm}} | ||
{{#parentPage:PXV:Operations|op.resetForm|operation}} | {{#parentPage:PXV:Operations|op.resetForm|operation}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
== Overview == | == Overview == | ||
| − | + | Resets the form fields to their initial state, removing all of the changes done. | |
== 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 containing the [[PXV:IPXC_Document|IPXC_Document]] that will have it's pages' forms reset. |
|- | |- | ||
| 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]] that had it's pages' forms reset. |
| + | |||
|- | |- | ||
| class="op_param_name" | [[PXV:op_resetForm_Options|Options]] | | class="op_param_name" | [[PXV:op_resetForm_Options|Options]] | ||
| Line 26: | Line 26: | ||
| Dictionary with options of the operation. | | Dictionary with options of the operation. | ||
|} | |} | ||
| + | |||
| + | == Sample == | ||
| + | <pre class="brush:c#">//C# | ||
| + | private void ResetForm(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst) | ||
| + | { | ||
| + | int nID = Inst.Str2ID("op.resetForm", 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"]; | ||
| + | //Resetting all of the form fields | ||
| + | options["Exclude"].v = true; | ||
| + | Op.Do(); | ||
| + | } | ||
| + | </pre> | ||
Latest revision as of 06:37, 21 April 2016
Overview
Resets the form fields to their initial state, removing all of the changes done.
Parameters
| Name | Type | Description |
|---|---|---|
| Input | Array | Array of IUnknown-based objects containing the IPXC_Document that will have it's pages' forms reset.
|
| Output | Array | Array of IUnknown-based objects containing the IPXC_Document that had it's pages' forms reset.
|
| Options | Dictionary | Dictionary with options of the operation. |
Sample
//C#
private void ResetForm(PDFXEdit.IPXV_Document Doc, PDFXEdit.IPXV_Inst Inst)
{
int nID = Inst.Str2ID("op.resetForm", 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"];
//Resetting all of the form fields
options["Exclude"].v = true;
Op.Do();
}
