SaveImages(ImageCollection,Stream,EventHandler<ProgressEventArgs>) Method (MultipageEncoderBase)

In This Topic

Saves the image collection to the stream.

Syntax

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

'Declaration

Public Overloads Function SaveImages( _
   ByVal imagesImageCollection object to save.
 As Vintasoft.Imaging.ImageCollection, _
   ByVal streamStream where the image from collection should be saved.
 As System.IO.Stream, _
   ByVal progressDelegateProgress delegate.
 As System.EventHandler(Of ProgressEventArgs) _
) As Boolean

public bool SaveImages(
   Vintasoft.Imaging.ImageCollection images, 
   System.IO.Stream stream, 
   System.EventHandler<ProgressEventArgs> progressDelegate
)

public: bool SaveImages(
   Vintasoft.Imaging.ImageCollection* images, 
   System.IO.Stream* stream, 
   System.EventHandler<ProgressEventArgs*>* progressDelegate
)

public:
bool SaveImages(
   Vintasoft.Imaging.ImageCollection^ images, 
   System.IO.Stream^ stream, 
   System.EventHandler<ProgressEventArgs^>^ progressDelegate
)

Parameters

images: ImageCollection object to save.
stream: Stream where the image from collection should be saved.
progressDelegate: Progress delegate.

Return Value

True - image collection is successfully saved to the stream;
false - image collection is not saved to the stream because collection is empty, saving is not necessary or canceled.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown if images or stream are null.
EncoderException	Thrown if image is locked and cannot be saved.

Remarks

This method must be overwritten in child classes.

Requirements

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

Reference

MultipageEncoderBase Class
MultipageEncoderBase Members

Overload List

Send Feedback