SaveSync(String,Boolean) Method (ImageCollection)

In This Topic

Saves synchronously all images from this collection to specified multipage image (JBIG2/PDF/TIFF) file.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration

Public Overloads Sub SaveSync( _
   ByVal filenameFilename where the image collection should be saved.
 As System.String, _
   ByVal createNewFileA value indicating whether a new file should be created.
 As Boolean _
)

public void SaveSync(
   System.String filename, 
   bool createNewFile
)

public: void SaveSync(
   System.String filename, 
   bool createNewFile
)

public:
void SaveSync(
   System.String filename, 
   bool createNewFile
)

Parameters

filename: Filename where the image collection should be saved.
createNewFile: A value indicating whether a new file should be created.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown if filename is null.
System.InvalidOperationException	Thrown if image collection does not contain images or another saving process is executing at this moment.
EncoderException	Thrown if encoder is not found for specified file extension or error occurs at saving the image.

Remarks

This method works synchronously.

Supported image formats: JBIG2, PDF, TIFF.

Suitable encoder is selected automatically from the extension of the filename, exception is thrown if encoder is not found for file extension specified in filename.

This method

saves images to new JBIG2/PDF/TIFF file specified by filename
file specified by filename is overwritten if it exists
saving process can be canceled, saving of images can be suppressed
sources of images in the image collection are not changed, i.e. images[i].SourceInfo.Filename is not changed

filename != images[0]..SourceInfo.Filename
SaveAndSwitchSource is false
createNewFile is true

This method

adds images to existing JBIG2/PDF/TIFF file specified by filename
saving process can be canceled, saving of images can be suppressed
sources of images in the image collection are not changed, i.e. images[i].SourceInfo.Filename is not changed

filename != images[0]..SourceInfo.Filename
SaveAndSwitchSource is false
createNewFile is false

This method

saves images to new JBIG2/PDF/TIFF file specified by filename
file specified by filename is overwritten if it exists, value of the createNewFile parameter is ignored
saving process cannot be canceled, saving of images cannot be suppressed
sources of images in the image collection are changed, i.e. images[i].SourceInfo.Filename is changed to filename

filename != images[0]..SourceInfo.Filename
SaveAndSwitchSource is true

This method

changes images in the source JBIG2/PDF/TIFF file if some images of source file are changed in the image collection
removes images from the source JBIG2/PDF/TIFF file if some images of source file are removed from the image collection
adds images to the source JBIG2/PDF/TIFF file if some images of NOT from the source file are added to the image collection
reindex images in the source JBIG2/PDF/TIFF file if images are reindexed in the image collection
file specified by filename is overwritten if it exists, value of the createNewFile parameter is ignored
saving process cannot be canceled, saving of images cannot be suppressed
sources of images in the image collection is changed, i.e. images[i].SourceInfo.Filename is changed to filename

filename == images[0]..SourceInfo.Filename
SaveAndSwitchSource is true

This method

throw an exception

filename == images[0]..SourceInfo.Filename
SaveAndSwitchSource is false

ImageSaving event will occur before saving of each image. In this event you can get information about the image, suppress image saving or cancel image saving process.
ImageSaved event will occur after saving of each image. In this event you can get information about progress of images saving process or cancel image saving process.

Example

This example illustrates how to save the image collection synchronously.

VB.NET


' save image collection to a TIFF file
' file will be overwritten if it exists
imageViewer1.Images.SaveSync("new-file-name.tif", True)


// save image collection to a TIFF file
// file will be overwritten if it exists
imageViewer1.Images.SaveSync("new-file-name.tif", true);

Requirements

Target Platforms: .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

ImageCollection Class
ImageCollection Members

SaveAndSwitchSource
DocumentConverter
Overload List

Send Feedback