PageSaveImageArea Method

public void SaveImageArea(
	string FileName,
	IMF_FORMAT Format,
	ref IPRORECT Rect,
	[OptionalAttribute] IMAGEINDEX IMAGEINDEX,
	[OptionalAttribute] bool Append
)

Public Sub SaveImageArea ( 
	FileName As String,
	Format As IMF_FORMAT,
	ByRef Rect As IPRORECT,
	<OptionalAttribute> IMAGEINDEX As IMAGEINDEX,
	<OptionalAttribute> Append As Boolean
)

public:
void SaveImageArea(
	[InAttribute] String^ FileName, 
	[InAttribute] IMF_FORMAT Format, 
	[InAttribute] IPRORECT% Rect, 
	[OptionalAttribute] [InAttribute] IMAGEINDEX IMAGEINDEX, 
	[OptionalAttribute] [InAttribute] bool Append
)

Parameters

FileName

Type: SystemString

Format

Type: Kofax.OmniPageCSDK.IproPlusIMF_FORMAT

Rect

Type: Kofax.OmniPageCSDK.IproPlusIPRORECT

IMAGEINDEX (Optional)

Type: Kofax.OmniPageCSDK.IproPlusIMAGEINDEX

Append (Optional)

Type: SystemBoolean

The FileName parameter is the fully qualified path to the image file. The Format parameter is the image format of the output. See the description of the Format property of the ImageFile object for the supported image formats.

With the optional IPRORECT Rect parameter, a rectangular area can be selected to export. If the left or top fields of the Rect parameter are unspecified, or less than zero, they will be treated as zero. If the width field of the Rect parameter is unspecified or less than 1, the operation saves up to the right edge of the selected page. If the height field of the Rect parameter is unspecified or less than 1, the operation saves down to the bottom edge of the selected page.

If the optional Boolean Append parameter is True and the selected image format is a multi-page one, the image is appended at the end of the image file. If the image file does not exist, it is created automatically. If the image file does not support multi-page images, a trappable error occurs. If the Append parameter is unspecified or is False, a single page image is created and if a file with the specified name already exists, it is overwritten.

The ImageIndex is an optional IMAGEINDEX parameter that selects which image of the page is be saved. Possible values are described under the SaveImage method. If the ImageIndex parameter is unspecified, the II_CURRENT image is saved.

Reference