Click or drag to resize

DocumentApplyFormTemplate Method

This method applies a form processing template file to a filled-in form image, when performing Form Data Extraction (FDE).

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public void ApplyFormTemplate(
	string Name,
	bool Embedded,
	[OptionalAttribute] Object Pages
)

Parameters

Name
Type: SystemString
Embedded
Type: SystemBoolean
Pages (Optional)
Type: SystemObject
Remarks

To create a form template file, call the CreateFormTemplate and SaveFormTemplate methods. The ApplyFormTemplate processes the form description stored in the template, registers the current image and places the stored and registered zones on the image.

If the Embedded parameter is True, the Name parameter specifies the name of an embedded, custom data stream of type CD_FORMTEMPLATE. If the Embedded parameter is False, the Name parameter specifies a fully qualified path to a form template file. Pages is an optional parameter of type RUNPAGE. To learn about available values, see the description of the RUNPAGE Enumeration topic. If the Pages parameter is unspecified, all document pages will have the form template applied to them.

UserZones collection is updated based on the template file, all references to the old UserZone objects become invalid. The OCRZones and Characters collections are cleared, the properties of the Statistics object except the ImageLoadTime and PreprocTime are set to zero. The Recognized property is cleared.

Calling this method sets the Modified property to True.

See Also