BitmapDecoder.Create Method (Stream, BitmapCreateOptions, BitmapCacheOption)


Creates a BitmapDecoder from a Stream by using the specified BitmapCreateOptions and BitmapCacheOption.

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

public static BitmapDecoder Create(
	Stream bitmapStream,
	BitmapCreateOptions createOptions,
	BitmapCacheOption cacheOption


Type: System.IO.Stream

The file stream that identifies the bitmap to decode.

Type: System.Windows.Media.Imaging.BitmapCreateOptions

Identifies the BitmapCreateOptions for this decoder.

Type: System.Windows.Media.Imaging.BitmapCacheOption

Identifies the BitmapCacheOption for this decoder.

Use the OnLoad cache option if you wish to close the bitmapStream after the decoder is created. The default OnDemand cache option retains access to the stream until the bitmap is needed, and cleanup is handled by the garbage collector.

The following example demonstrates how to use the Create method to create a decoder for a given image. The first BitmapFrame of the image is used as the source of an Image control.

Stream imageStream = new FileStream("sampleImages/waterlilies.jpg",
   FileMode.Open, FileAccess.Read, FileShare.Read);

BitmapDecoder streamBitmap = BitmapDecoder.Create(
   imageStream, BitmapCreateOptions.None,

// Create an image element;
Image streamImage = new Image();
streamImage.Width = 200;
// Set image source using the first frame.
streamImage.Source = streamBitmap.Frames[0];

.NET Framework
Available since 3.0
Return to top