BitmapEncoder.Save(Stream) Method

Reference

Definition

Namespace:: System.Windows.Media.Imaging

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Encodes a bitmap image to a specified Stream.

public:
 virtual void Save(System::IO::Stream ^ stream);

[System.Security.SecurityCritical]
public virtual void Save(System.IO.Stream stream);

public virtual void Save(System.IO.Stream stream);

[<System.Security.SecurityCritical>]
abstract member Save : System.IO.Stream -> unit
override this.Save : System.IO.Stream -> unit

abstract member Save : System.IO.Stream -> unit
override this.Save : System.IO.Stream -> unit

Public Overridable Sub Save (stream As Stream)

Parameters

stream: Stream

Identifies the file stream that this bitmap is encoded to.

Attributes: SecurityCriticalAttribute

Exceptions

InvalidOperationException

The bitmap has already been encoded.

NotSupportedException

The Frames count is less than or equal to zero.

Examples

The following example demonstrates how to save a bitmap image to a file stream by using the derived TiffBitmapEncoder class.

FileStream stream = new FileStream("empty.tif", FileMode.Create);
TiffBitmapEncoder encoder = new TiffBitmapEncoder();
TextBlock myTextBlock = new TextBlock();
myTextBlock.Text = "Codec Author is: " + encoder.CodecInfo.Author.ToString();
encoder.Frames.Add(BitmapFrame.Create(image));
MessageBox.Show(myPalette.Colors.Count.ToString());
encoder.Save(stream);

Dim stream As New FileStream("empty.tif", FileMode.Create)
Dim encoder As New TiffBitmapEncoder()
Dim myTextBlock As New TextBlock()
myTextBlock.Text = "Codec Author is: " + encoder.CodecInfo.Author.ToString()
encoder.Frames.Add(BitmapFrame.Create(image))
MessageBox.Show(myPalette.Colors.Count.ToString())
encoder.Save(stream)

Remarks

In the context of this API, "save" and "encode" are synonymous.

Applies to

Product	Versions
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via