BitmapEncoder.Save Method (Stream)

 

Encodes a bitmap image to a specified Stream.

Namespace:   System.Windows.Media.Imaging
Assembly:  PresentationCore (in PresentationCore.dll)

[SecurityCriticalAttribute]
[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
[SecurityPermissionAttribute(SecurityAction.InheritanceDemand, 
	Flags = SecurityPermissionFlag.UnmanagedCode)]
public virtual void Save(
	Stream stream
)

Parameters

stream
Type: System.IO.Stream

Identifies the file stream that this bitmap is encoded to.

Exception Condition
InvalidOperationException

The bitmap has already been encoded.

NotSupportedException

The Frames value that is passed to the encoder is null.

NotSupportedException

The Frames count is less than or equal to zero.

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

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);

.NET Framework
Available since 3.0
Return to top
Show: