ImageFile.UpdatePageFromBitmap Method

public void UpdatePageFromBitmap(
	MemoryBitmap Bitmap,
	[OptionalAttribute] int Page,
	[OptionalAttribute] IMF_FORMAT DstFormat
)

Public Sub UpdatePageFromBitmap ( 
	Bitmap As MemoryBitmap,
	<OptionalAttribute> Page As Integer,
	<OptionalAttribute> DstFormat As IMF_FORMAT
)

public:
void UpdatePageFromBitmap(
	[InAttribute] MemoryBitmap^ Bitmap, 
	[OptionalAttribute] [InAttribute] int Page, 
	[OptionalAttribute] [InAttribute] IMF_FORMAT DstFormat
)

Parameters

Bitmap

Type: Kofax.OmniPageCSDK.IproPlus.MemoryBitmap

Page (Optional)

Type: System.Int32

DstFormat (Optional)

Type: Kofax.OmniPageCSDK.IproPlus.IMF_FORMAT

The Page is an optional numeric parameter specifying the index of the page to be updated. If it is unspecified or -1 the first page will be replaced.

This method can only be used with multi-page image TIFF files. A further requirement is that the pages already 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 describes the compression method of the new page. It can be one of the following values: FF_TIFNO, FF_TIFPB, FF_TIFHU, FF_TIFG31, FF_TIFG32, FF_TIFG4, FF_TIFLZW and FF_TIFJPGNEW. If it unspecified, FF_TIFLZW is used.

Reference