BitmapDecoder.Create Method (Uri, BitmapCreateOptions, BitmapCacheOption) (System.Windows.Media.Imaging)

MSDN Library
.NET Development
.NET Framework 3.5
.NET Framework Class Library
System.Windows.Media.Imaging Namespace
BitmapDecoder Class
BitmapDecoder Methods
Create Method

Create Method (Stream, BitmapCreateOptions, BitmapCacheOption)

Create Method (Uri, BitmapCreateOptions, BitmapCacheOption)

Create Method (Uri, BitmapCreateOptions, BitmapCacheOption, RequestCachePolicy)

BitmapDecoder..::.Create Method (Uri, BitmapCreateOptions, BitmapCacheOption)
This page is specific to:.NET Framework Version:3.03.54.0

.NET Framework Class Library

BitmapDecoder..::.Create Method (Uri, BitmapCreateOptions, BitmapCacheOption)

Creates a BitmapDecoder from a Uri by using the specified BitmapCreateOptions and BitmapCacheOption.

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

Syntax

C++

JScript

Copy to Clipboard Print

'Usage

Dim bitmapUri As Uri
Dim createOptions As BitmapCreateOptions
Dim cacheOption As BitmapCacheOption
Dim returnValue As BitmapDecoder

returnValue = BitmapDecoder.Create(bitmapUri, _
    createOptions, cacheOption)

'Declaration

Public Shared Function Create ( _
    bitmapUri As Uri, _
    createOptions As BitmapCreateOptions, _
    cacheOption As BitmapCacheOption _
) As BitmapDecoder

XAML

You cannot use methods in XAML.

Parameters

bitmapUri: Type: System..::.Uri
The Uri of the bitmap to decode.

createOptions: Type: System.Windows.Media.Imaging..::.BitmapCreateOptions
Identifies the BitmapCreateOptions for this decoder.

cacheOption: Type: System.Windows.Media.Imaging..::.BitmapCacheOption
Identifies the BitmapCacheOption for this decoder.

Return Value

Type: System.Windows.Media.Imaging..::.BitmapDecoder
A new BitmapDecoder.

Exceptions

Exception	Condition
ArgumentNullException	The bitmapUri is nullNothingnullptra null reference (Nothing in Visual Basic).
FileFormatException	The bitmapUri specifies a class ID of an unsupported format type.

Examples

The following example demonstrates how to use the Create(Uri, BitmapCreateOptions, BitmapCacheOption) method to create a decoder for a given image. The first BitmapFrame of the image is used as the source of an Image control.

C++

JScript

Copy to Clipboard Print

Dim uriBitmap As BitmapDecoder = BitmapDecoder.Create(New Uri("sampleImages/waterlilies.jpg", UriKind.Relative), BitmapCreateOptions.None, BitmapCacheOption.Default)

' Create an image element;
Dim uriImage As New Image()
uriImage.Width = 200
' Set image source.
uriImage.Source = uriBitmap.Frames(0)

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

BitmapDecoder Class

BitmapDecoder Members

Create Overload

System.Windows.Media.Imaging Namespace

BitmapSource