ImageFileSaveAs Method

public void SaveAs(
	string FileName,
	IMF_FORMAT Format,
	[OptionalAttribute] int Page
)

Public Sub SaveAs ( 
	FileName As String,
	Format As IMF_FORMAT,
	<OptionalAttribute> Page As Integer
)

public:
void SaveAs(
	[InAttribute] String^ FileName, 
	[InAttribute] IMF_FORMAT Format, 
	[OptionalAttribute] [InAttribute] int Page
)

Parameters

FileName

Type: SystemString

Format

Type: Kofax.OmniPageCSDK.IproPlusIMF_FORMAT

Page (Optional)

Type: SystemInt32

If the file specified by the FileName parameter already exists, it will be overwritten. If the optional numeric Page parameter is specified and not equal to -1, the referred page will be stored into the new file. Otherwise all pages will be exported. If there are multiple pages being saved, but the Format parameter specifies a single-page file format, multiple files are created based on the FileName parameter by appending ordinal numbers at the end of the file names. The value of appended digits is calculated using the PageCount property. For details about the available Format parameter values, see the Format property documentation.

If the current image format does not match the requested output format specified by the Format parameter, automatic conversion is performed when creating the output file. An example of such a conversion is,if the current image is a color image and only a Black and White enabled output format is specified. In this case, the exported pages will be converted to Black and White.

Reference