WmpBitmapDecoder Constructors

Definition

Namespace:

System.Windows.Media.Imaging

Assembly:

PresentationCore.dll

Initializes a new instance of WmpBitmapDecoder.

Overloads

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

WmpBitmapDecoder(Stream, BitmapCreateOptions, BitmapCacheOption)

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

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

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

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

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 caching method for the bitmap image.

Exceptions

ArgumentNullException

The bitmapStream value is null.

FileFormatException

The bitmapStream is not a Windows Media Photo encoded image.

Examples

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

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

WmpBitmapDecoder(Uri, BitmapCreateOptions, BitmapCacheOption)

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

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

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

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

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 caching method for the bitmap image.

Exceptions

ArgumentNullException

The bitmapUri value is null.

FileFormatException

The bitmapUri is not a Windows Media Photo encoded image.

Examples

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

// Open a Uri and decode a WDP image
System::Uri^ myUri = gcnew System::Uri("tulipfarm.wdp", UriKind::RelativeOrAbsolute);
WmpBitmapDecoder^ decoder3 = gcnew WmpBitmapDecoder(myUri, BitmapCreateOptions::PreservePixelFormat, BitmapCacheOption::Default);
BitmapSource^ bitmapSource3 = decoder3->Frames[0];

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

// Open a Uri and decode a WDP image
Uri myUri = new Uri("tulipfarm.wdp", UriKind.RelativeOrAbsolute);
WmpBitmapDecoder decoder3 = new WmpBitmapDecoder(myUri, BitmapCreateOptions.PreservePixelFormat, BitmapCacheOption.Default);
BitmapSource bitmapSource3 = decoder3.Frames[0];

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

' Open a Uri and decode a WDP image
Dim myUri As New Uri("tulipfarm.wdp", UriKind.RelativeOrAbsolute)
Dim decoder3 As New WmpBitmapDecoder(myUri, BitmapCreateOptions.PreservePixelFormat, BitmapCacheOption.Default)
Dim bitmapSource3 As BitmapSource = decoder3.Frames(0)

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