GifBitmapDecoder Constructor (Stream, BitmapCreateOptions, BitmapCacheOption)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Initializes a new instance of GifBitmapDecoder from the specified file stream with the specified createOptions and cacheOption.

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

[SecurityCriticalAttribute]
public GifBitmapDecoder(
	Stream bitmapStream,
	BitmapCreateOptions createOptions,
	BitmapCacheOption cacheOption
)

Parameters

bitmapStream
Type: System.IO.Stream

Bitmap stream to decode.

createOptions
Type: System.Windows.Media.Imaging.BitmapCreateOptions

Initialization options for the bitmap image.

cacheOption
Type: System.Windows.Media.Imaging.BitmapCacheOption

The cache method to use for the bitmap image.

Exception Condition
ArgumentNullException

The bitmapStream value is null.

FileFormatException

The bitmapStream is not a Graphics Interchange Format (GIF) encoded image.

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 code example demonstrates how to create an instance of and use a GifBitmapDecoder from a file stream. The decoded image is used as the source of an Image control.


// Open a Stream and decode a GIF image
Stream imageStreamSource = new FileStream("tulipfarm.gif", FileMode.Open, FileAccess.Read, FileShare.Read);
GifBitmapDecoder decoder = new GifBitmapDecoder(imageStreamSource, BitmapCreateOptions.PreservePixelFormat, BitmapCacheOption.Default);
BitmapSource bitmapSource = decoder.Frames[0];

// Draw the Image
Image myImage = new Image();
myImage.Source = bitmapSource;
myImage.Stretch = Stretch.None;
myImage.Margin = new Thickness(20);

.NET Framework
Available since 3.0
Return to top
Show: