Save(String,WiaImageEncoderSettings) Method (WiaAcquiredImage)
In This Topic
Saves this image to a file.
Syntax
Parameters
- filename
- Name of file where image must be saved.
- encoderSettings
- Image encoder settings.
Exceptions
Remarks
Image can be:
- saved as image file (BMP, JPEG, PNG, TIFF)
- added to multipage TIFF file
- saved into new PDF or PDF/A document
- added to existing PDF or PDF/A document
Available compressions for images saved into TIFF file:
- without compression
- CCITT Group 4 Fax compression
- LZW compression
- ZIP compression
- JPEG compression
Available compressions for images saved into PDF document:
- without compression
- CCITT Group 4 Fax compression
- LZW compression
- ZIP compression
- JPEG compression
Image can be added to a PDF document compatible with version 1.4 or earlier of PDF standard.
Image will be saved as BMP file if
- encoderSettings is null and filename contains 'bmp' extension
- encoderSettings is not null and encoderSettings is an instance of type WiaBmpEncoderSettings
Image will be saved as JPEG file if
- encoderSettings is null and filename contains not 'bmp', 'png', 'pdf', 'tif' and 'tiff' extension
- encoderSettings is not null and encoderSettings is an instance of type WiaJpegEncoderSettings
Image will be saved as PDF file if
- encoderSettings is null and filename contains 'pdf' extension
- encoderSettings is not null and encoderSettings is an instance of type WiaPdfEncoderSettings
Image will be saved as PNG file if
- encoderSettings is null and filename contains 'png' extension
- encoderSettings is not null and encoderSettings is an instance of type WiaPngEncoderSettings
Image will be saved as TIFF file if
- encoderSettings is null and filename contains 'tif' or 'tiff' extension
- encoderSettings is not null and encoderSettings is an instance of type WiaTiffEncoderSettings
Example
This C#/VB.NET code shows how to acquire images from WIA device and save images to a TIFF file.
''' <summary>
''' Acquires images from WIA device and saves images to a TIFF file.
''' </summary>
Public Sub AcquireImagesFromWiaDeviceAndSaveImagesToTiffFile()
' create WIA device manager
Using deviceManager As New Vintasoft.WiaImageScanning.WiaDeviceManager()
' open WIA device manager
deviceManager.Open()
' get count of WIA devices
Dim deviceCount As Integer = deviceManager.Devices.Count
If deviceCount = 0 Then
System.Console.WriteLine("Devices are not found.")
Return
End If
' select the first WIA device
Dim device As Vintasoft.WiaImageScanning.WiaDevice = deviceManager.Devices(0)
' open WIA device
device.Open()
Dim acquiredImage As Vintasoft.WiaImageScanning.WiaAcquiredImage = Nothing
Do
Try
' acquire image from WIA device
acquiredImage = device.AcquireImageSync()
' if image is received
If acquiredImage IsNot Nothing Then
System.Console.WriteLine("Image is acquired.")
' create TIFF encoder settings
Dim tiffEncoderSettings As New Vintasoft.WiaImageScanning.ImageEncoders.WiaTiffEncoderSettings()
' specify that image must be added to a TIFF file
tiffEncoderSettings.TiffMultiPage = True
' specify image must be compressed with LZW compression
tiffEncoderSettings.TiffCompression = Vintasoft.WiaImageScanning.ImageEncoders.WiaTiffCompression.LZW
' process acquired image
acquiredImage.Save("test.tif", tiffEncoderSettings)
Else
' if image is not received
System.Console.WriteLine("Scan is completed.")
Exit Try
End If
Catch ex As System.Exception
System.Console.WriteLine(String.Format("Scan is failed: {0}", ex.Message))
Exit Try
End Try
' while image is acquired
Loop While acquiredImage IsNot Nothing
' close WIA device
device.Close()
' close WIA device manager
deviceManager.Close()
End Using
System.Console.ReadLine()
End Sub
/// <summary>
/// Acquires images from WIA device and saves images to a TIFF file.
/// </summary>
public void AcquireImagesFromWiaDeviceAndSaveImagesToTiffFile()
{
// create WIA device manager
using (Vintasoft.WiaImageScanning.WiaDeviceManager deviceManager = new Vintasoft.WiaImageScanning.WiaDeviceManager())
{
// open WIA device manager
deviceManager.Open();
// get count of WIA devices
int deviceCount = deviceManager.Devices.Count;
if (deviceCount == 0)
{
System.Console.WriteLine("Devices are not found.");
return;
}
// select the first WIA device
Vintasoft.WiaImageScanning.WiaDevice device = deviceManager.Devices[0];
// open WIA device
device.Open();
Vintasoft.WiaImageScanning.WiaAcquiredImage acquiredImage = null;
do
{
try
{
// acquire image from WIA device
acquiredImage = device.AcquireImageSync();
// if image is received
if (acquiredImage != null)
{
System.Console.WriteLine("Image is acquired.");
// create TIFF encoder settings
Vintasoft.WiaImageScanning.ImageEncoders.WiaTiffEncoderSettings tiffEncoderSettings =
new Vintasoft.WiaImageScanning.ImageEncoders.WiaTiffEncoderSettings();
// specify that image must be added to a TIFF file
tiffEncoderSettings.TiffMultiPage = true;
// specify image must be compressed with LZW compression
tiffEncoderSettings.TiffCompression = Vintasoft.WiaImageScanning.ImageEncoders.WiaTiffCompression.LZW;
// process acquired image
acquiredImage.Save("test.tif", tiffEncoderSettings);
}
// if image is not received
else
{
System.Console.WriteLine("Scan is completed.");
break;
}
}
catch (System.Exception ex)
{
System.Console.WriteLine(string.Format("Scan is failed: {0}", ex.Message));
break;
}
}
// while image is acquired
while (acquiredImage != null);
// close WIA device
device.Close();
// close WIA device manager
deviceManager.Close();
}
System.Console.ReadLine();
}
Requirements
Target Platforms: .NET 10; .NET 9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5
See Also