BmpBitmapDecoder Constructors

Definition

Namespace:

System.Windows.Media.Imaging

Assembly:

PresentationCore.dll

Initializes a new instance of BmpBitmapDecoder.

Overloads

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

BmpBitmapDecoder(Stream, BitmapCreateOptions, BitmapCacheOption)

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

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

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

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

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

Parameters

bitmapStream

Stream

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 a bitmap (BMP) encoded image.

Examples

The following code example demonstrates how to create an instance of and use a BmpBitmapDecoder from a file stream. The decoded image is used as the source of an Image control.

// Open a Stream and decode a BMP image
Stream^ imageStreamSource = gcnew FileStream("tulipfarm.bmp", FileMode::Open, FileAccess::Read, FileShare::Read);
BmpBitmapDecoder^ decoder = gcnew BmpBitmapDecoder(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 BMP image
Stream imageStreamSource = new FileStream("tulipfarm.bmp", FileMode.Open, FileAccess.Read, FileShare.Read);
BmpBitmapDecoder decoder = new BmpBitmapDecoder(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 BMP image
Dim imageStreamSource As New FileStream("tulipfarm.bmp", FileMode.Open, FileAccess.Read, FileShare.Read)
Dim decoder As New BmpBitmapDecoder(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 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.

BmpBitmapDecoder(Uri, BitmapCreateOptions, BitmapCacheOption)

Initializes a new instance of BmpBitmapDecoder from the specified Uri with the specified createOptions and cacheOption.

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

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

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

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

Parameters

bitmapUri

Uri

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 a bitmap (BMP) encoded image.

Examples

The following code example demonstrates how to create an instance of and use a BmpBitmapDecoder from a Uri. The decoded image is used as the source of an Image control.

// Open a Uri and decode a BMP image
System::Uri^ myUri = gcnew System::Uri("tulipfarm.bmp", UriKind::RelativeOrAbsolute);
BmpBitmapDecoder^ decoder2 = gcnew BmpBitmapDecoder(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 BMP image
Uri myUri = new Uri("tulipfarm.bmp", UriKind.RelativeOrAbsolute);
BmpBitmapDecoder decoder2 = new BmpBitmapDecoder(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 BMP image
Dim myUri As New Uri("tulipfarm.bmp", UriKind.RelativeOrAbsolute)
Dim decoder2 As New BmpBitmapDecoder(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)