DocumentSaveImages Method

public void SaveImages(
	string FileName,
	IMF_FORMAT Format,
	[OptionalAttribute] Object MultiPage,
	[OptionalAttribute] Object Range,
	[OptionalAttribute] Object NumberingBase,
	[OptionalAttribute] Object NumberingDigits,
	[OptionalAttribute] Object IMAGEINDEX
)

Public Sub SaveImages ( 
	FileName As String,
	Format As IMF_FORMAT,
	<OptionalAttribute> MultiPage As Object,
	<OptionalAttribute> Range As Object,
	<OptionalAttribute> NumberingBase As Object,
	<OptionalAttribute> NumberingDigits As Object,
	<OptionalAttribute> IMAGEINDEX As Object
)

public:
void SaveImages(
	[InAttribute] String^ FileName, 
	[InAttribute] IMF_FORMAT Format, 
	[OptionalAttribute] [InAttribute] Object^ MultiPage, 
	[OptionalAttribute] [InAttribute] Object^ Range, 
	[OptionalAttribute] [InAttribute] Object^ NumberingBase, 
	[OptionalAttribute] [InAttribute] Object^ NumberingDigits, 
	[OptionalAttribute] [InAttribute] Object^ IMAGEINDEX
)

Parameters

FileName

Type: SystemString

Format

Type: Kofax.OmniPageCSDK.IproPlusIMF_FORMAT

MultiPage (Optional)

Type: SystemObject

Range (Optional)

Type: SystemObject

NumberingBase (Optional)

Type: SystemObject

NumberingDigits (Optional)

Type: SystemObject

IMAGEINDEX (Optional)

Type: SystemObject

The FileName parameter specifies the fully qualified path of the image file being created. Format specifies one of the available IMF_FORMAT values. See the description of the Format property of the ImageFile object for the supported image formats. The type of the optional MultiPage parameter is Boolean. If this parameter is True and the specified image format supports multi-page image files, a single multi-page image is created. Otherwise each exported page generates an individual file.

The Range parameter of type RUNPAGE determines what document pages should be saved. According to the value passed, the active, selected, unrecognized, recognized or all pages are saved.

The available values for this property are listed in the description of the ImagePreprocess method. The default value for this parameter is RP_ALL.

The optional NumberingBase and NumberingDigits parameters are numeric. If multiple image files are being created, the file names are generated using the FileName parameter which is modified by adding an incrementing ordinal number prior to the extension. This numbering begins with the value specified by the NumberingBase parameter and consists of NumberingDigits characters, padded with zeros if necessary. If these parameters are not specified, the numbering begins with zero and the required digit number is calculated dynamically. The ImageIndex optional parameter is of type IMAGEINDEX determining which engine-managed images should be exported.

Reference