Click or drag to resize

DocumentApplyZoneTemplate Method

This method can be used to apply a saved zone template to one or more pages in the document.

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

Parameters

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

If the Embedded parameter is True, the Name parameter specifies the name of an embedded, custom data stream of type CD_TEMPLATE. If the Embedded parameter is False, the Name parameter specifies a fully qualified path to a zone file.

You can create a zone template file using the UserZones collection's SaveTemplate method. To store an existing zone template file in the document, use the CDImport method. Pages is an optional parameter of the type RUNPAGE. To learn available values, see the description of the ImagePreprocess method. If the Pages parameter is unspecified, all document pages will have the zone template applied to them.

Calling this method changes the related page properties as follows: the UserZones collection is updated according to 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