Click or drag to resize

DocumentImagePreprocess Method

This method performs image preprocessing according to the current document settings.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public void ImagePreprocess(
	[OptionalAttribute] Object Pages
)

Parameters

Pages (Optional)
Type: SystemObject
Remarks

These settings can be accessed through the Inversion, ResEnhancement, FaxCorrection, DownSample, Rotation, Despeckle, Deskew and Slope properties. Pages is an optional RUNPAGE parameter. Its possible values are listed under the RUNPAGE Enumeration topic.

Even though a set of pages might have a selected status, only a single page that displayed in the text editor and image viewer (if attached) is actually selected. If this optional parameter is unspecified, all pages are processed. Only pages not yet preprocessed (i.e. the Preprocessed property of the page returns False) are preprocessed by the method.

Calling this method changes the current page data as detailed below:

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