op.resetForm

From Tracker Software PDF SDK
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:
  
 
== Overview ==
 
== Overview ==
Resets the form fields to the initial state, removing all of the changes done.
+
Resets the form fields to their initial state, removing all of the changes done.
  
 
== Parameters ==
 
== Parameters ==
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();
}