Click or drag to resize

ImageFile.UpdatePage Method

This method updates a single page specified by the Page index parameter with a new image at the index SrcPage, stored in the image file defined by the SrcImage parameter.

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
Copy
public void UpdatePage(
	int Page,
	ImageFile SrcImage,
	int SrcPage,
	[OptionalAttribute] IMF_FORMAT DstFormat
)

Parameters

Page
Type: System.Int32
SrcImage
Type: Kofax.OmniPageCSDK.IproPlus.ImageFile
SrcPage
Type: System.Int32
DstFormat (Optional)
Type: Kofax.OmniPageCSDK.IproPlus.IMF_FORMAT
Remarks

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.

The DstFormat is an optional parameter of type IMF_FORMAT, which defines the compression method of the new page or pages. If DstFormat is unspecified and the source image is a TIFF, the compression method of the source page is used. If DstFormat is unspecified and the source image is not a TIFF, the FF_TIFLZW default compression method is used. The available values for this parameter are: FF_TIFNO, FF_TIFPB, FF_TIFHU, FF_TIFG31, FF_TIFG32, FF_TIFG4, FF_TIFLZW and FF_TIFJPGNEW.

See Also