ImageFileClear Method

public void Clear(
	ref IPRORECT Rect,
	[OptionalAttribute] int Page
)

Public Sub Clear ( 
	ByRef Rect As IPRORECT,
	<OptionalAttribute> Page As Integer
)

public:
void Clear(
	[InAttribute] IPRORECT% Rect, 
	[OptionalAttribute] [InAttribute] int Page
)

Parameters

Rect

Type: Kofax.OmniPageCSDK.IproPlusIPRORECT

Page (Optional)

Type: SystemInt32

Clear means that every bit in the area will be set to zero. This means white for binary images and black for color and gray images. For palette images the resulting color depends on the palette and the color corresponding to the 0 index. If the Page parameter is unspecified or -1 all pages will be processed. Otherwise only the one specified by the Page index will be processed. To process the whole image area, pass NULL (or Nothing) for the Rect parameter.

This method can only be used with multi-page image TIFF files. A further requirement is that the pages in the multi-page TIFF file must be stored in one-strip format and the StripBytesCount TIFF tag must exist in the page header. TIFF image files created by the Capture SDK fulfill this requirement.

Reference