Click or drag to resize

DocumentApplyPreprocessTemplate Method

This method performs template-based preprocessing on one or more document pages.

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

Parameters

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

The Name and Embedded parameters specify the template to be used as detailed in the SetPreprocessTemplate method description. The optional Pages parameter is of type RUNPAGE and specifies which document pages should be processed. Supported RUNPAGE values are listed in the description of the RUNPAGE Enumeration.

Preprocessing runs only on pages whose Preprocessed property value is False (not yet preprocessed).

Calling this method changes the current page data as described: All OCRZones and Characters collections are cleared. The PreprocTime property is calculated and updated in the Statistics object; the other properties of the Statistics object except the ImageLoadTime property are reset to zero. The Preprocessed property is set to True. The Recognized property is set to False.

Calling this method sets the Modified property to True.

See Also