IconBitmapDecoder Constructors

Definition

Namespace:

System.Windows.Media.Imaging

Assembly:

PresentationCore.dll

Initializes a new instance of the IconBitmapDecoder class.

Overloads

IconBitmapDecoder(Stream, BitmapCreateOptions, BitmapCacheOption)	Initializes a new instance of the IconBitmapDecoder class from the specified file stream, with the specified createOptions and cacheOption.
IconBitmapDecoder(Uri, BitmapCreateOptions, BitmapCacheOption)	Initializes a new instance of the IconBitmapDecoder class from the specified Uri, with the specified createOptions and cacheOption.

IconBitmapDecoder(Stream, BitmapCreateOptions, BitmapCacheOption)

Initializes a new instance of the IconBitmapDecoder class from the specified file stream, with the specified createOptions and cacheOption.

public:
 IconBitmapDecoder(System::IO::Stream ^ bitmapStream, System::Windows::Media::Imaging::BitmapCreateOptions createOptions, System::Windows::Media::Imaging::BitmapCacheOption cacheOption);

public IconBitmapDecoder (System.IO.Stream bitmapStream, System.Windows.Media.Imaging.BitmapCreateOptions createOptions, System.Windows.Media.Imaging.BitmapCacheOption cacheOption);

new System.Windows.Media.Imaging.IconBitmapDecoder : System.IO.Stream * System.Windows.Media.Imaging.BitmapCreateOptions * System.Windows.Media.Imaging.BitmapCacheOption -> System.Windows.Media.Imaging.IconBitmapDecoder

Public Sub New (bitmapStream As Stream, createOptions As BitmapCreateOptions, cacheOption As BitmapCacheOption)

Parameters

bitmapStream

Stream

The bitmap stream to decode.

createOptions

BitmapCreateOptions

Initialization options for the bitmap image.

cacheOption

BitmapCacheOption

The cache method to use for the bitmap image.

Exceptions

ArgumentNullException

The bitmapStream value is null.

FileFormatException

The bitmapStream is not an icon encoded image.

Examples

The following code example demonstrates how to create an instance of and use a GifBitmapDecoder from a file stream.

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

// Draw the Image
Image^ myImage = gcnew Image();
myImage->Source = bitmapSource;
myImage->Stretch = Stretch::None;
myImage->Margin = System::Windows::Thickness(20);

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

' Open a Stream and decode a GIF image
Dim imageStreamSource As New FileStream("tulipfarm.gif", FileMode.Open, FileAccess.Read, FileShare.Read)
Dim decoder As New GifBitmapDecoder(imageStreamSource, BitmapCreateOptions.PreservePixelFormat, BitmapCacheOption.Default)
Dim bitmapSource As BitmapSource = decoder.Frames(0)

' Draw the Image
Dim myImage As New Image()
myImage.Source = bitmapSource
myImage.Stretch = Stretch.None
myImage.Margin = New Thickness(20)

Remarks

Use the OnLoad cache option if you wish to close the bitmapStream after the bitmap 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.

IconBitmapDecoder(Uri, BitmapCreateOptions, BitmapCacheOption)

Initializes a new instance of the IconBitmapDecoder class from the specified Uri, with the specified createOptions and cacheOption.

public:
 IconBitmapDecoder(Uri ^ bitmapUri, System::Windows::Media::Imaging::BitmapCreateOptions createOptions, System::Windows::Media::Imaging::BitmapCacheOption cacheOption);

public IconBitmapDecoder (Uri bitmapUri, System.Windows.Media.Imaging.BitmapCreateOptions createOptions, System.Windows.Media.Imaging.BitmapCacheOption cacheOption);

new System.Windows.Media.Imaging.IconBitmapDecoder : Uri * System.Windows.Media.Imaging.BitmapCreateOptions * System.Windows.Media.Imaging.BitmapCacheOption -> System.Windows.Media.Imaging.IconBitmapDecoder

Public Sub New (bitmapUri As Uri, createOptions As BitmapCreateOptions, cacheOption As BitmapCacheOption)

Parameters

bitmapUri

Uri

The Uri that identifies the bitmap to decode.

createOptions

BitmapCreateOptions

Initialization options for the bitmap image.

cacheOption

BitmapCacheOption

The cache method to use for the bitmap image.

Exceptions

ArgumentNullException

The bitmapUri value is null.

FileFormatException

The bitmapUri is not an icon encoded image.

Examples

The following code example demonstrates how to create an instance of and use a GifBitmapDecoder from a Uri.

// Open a Uri and decode a GIF image
System::Uri^ myUri = gcnew System::Uri("tulipfarm.gif", UriKind::RelativeOrAbsolute);
GifBitmapDecoder^ decoder2 = gcnew GifBitmapDecoder(myUri, BitmapCreateOptions::PreservePixelFormat, BitmapCacheOption::Default);
BitmapSource^ bitmapSource2 = decoder2->Frames[0];

// Draw the Image
Image^ myImage2 = gcnew Image();
myImage2->Source = bitmapSource2;
myImage2->Stretch = Stretch::None;
myImage2->Margin = System::Windows::Thickness(20);

// Open a Uri and decode a GIF image
Uri myUri = new Uri("tulipfarm.gif", UriKind.RelativeOrAbsolute);
GifBitmapDecoder decoder2 = new GifBitmapDecoder(myUri, BitmapCreateOptions.PreservePixelFormat, BitmapCacheOption.Default);
BitmapSource bitmapSource2 = decoder2.Frames[0];

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

' Open a Uri and decode a GIF image
Dim myUri As New Uri("tulipfarm.gif", UriKind.RelativeOrAbsolute)
Dim decoder2 As New GifBitmapDecoder(myUri, BitmapCreateOptions.PreservePixelFormat, BitmapCacheOption.Default)
Dim bitmapSource2 As BitmapSource = decoder2.Frames(0)

' Draw the Image
Dim myImage2 As New Image()
myImage2.Source = bitmapSource2
myImage2.Stretch = Stretch.None
myImage2.Margin = New Thickness(20)