TiffBitmapDecoder Constructors

Definition

Namespace:

System.Windows.Media.Imaging

Assembly:

PresentationCore.dll

Initializes a new instance of the TiffBitmapDecoder class.

Overloads

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

TiffBitmapDecoder(Stream, BitmapCreateOptions, BitmapCacheOption)

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

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

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

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

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 Tagged Image File Format (TIFF) encoded image.

Examples

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

// Open a Stream and decode a TIFF image.
Stream^ imageStreamSource = gcnew FileStream("tulipfarm.tif", FileMode::Open, FileAccess::Read, FileShare::Read);
TiffBitmapDecoder^ decoder = gcnew TiffBitmapDecoder(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 TIFF image.
Stream imageStreamSource = new FileStream("tulipfarm.tif", FileMode.Open, FileAccess.Read, FileShare.Read);
var decoder = new TiffBitmapDecoder(imageStreamSource, BitmapCreateOptions.PreservePixelFormat, BitmapCacheOption.Default);
BitmapSource bitmapSource = decoder.Frames[0];

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

' Open a Stream and decode a TIFF image.
Dim imageStreamSource As New FileStream("tulipfarm.tif", FileMode.Open, FileAccess.Read, FileShare.Read)
Dim decoder As New TiffBitmapDecoder(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.

TiffBitmapDecoder(Uri, BitmapCreateOptions, BitmapCacheOption)

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

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

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

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

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 Tagged Image File Format (TIFF) encoded image.

Examples

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

// Open a Uri and decode a TIFF image.
System::Uri^ myUri = gcnew System::Uri("tulipfarm.tif", UriKind::RelativeOrAbsolute);
TiffBitmapDecoder^ decoder2 = gcnew TiffBitmapDecoder(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 TIFF image.
var myUri = new Uri("tulipfarm.tif", UriKind.RelativeOrAbsolute);
var decoder2 = new TiffBitmapDecoder(myUri, BitmapCreateOptions.PreservePixelFormat, BitmapCacheOption.Default);
BitmapSource bitmapSource2 = decoder2.Frames[0];

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

' Open a Uri and decode a TIFF image.
Dim myUri As New Uri("tulipfarm.tif", UriKind.RelativeOrAbsolute)
Dim decoder2 As New TiffBitmapDecoder(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)