BitmapImage.CacheOption Property (System.Windows.Media.Imaging)

Switch View

CacheOption Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

BitmapImage..::.CacheOption Property

Gets or sets the BitmapCacheOption to use for this instance of BitmapImage. This is a dependency property.

Namespace: System.Windows.Media.Imaging
Assembly: PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

Syntax

Visual Basic (Declaration)

Public Property CacheOption As BitmapCacheOption

Visual Basic (Usage)

Dim instance As BitmapImage
Dim value As BitmapCacheOption

value = instance.CacheOption

instance.CacheOption = value

public BitmapCacheOption CacheOption { get; set; }

Visual C++

public:
property BitmapCacheOption CacheOption {
    BitmapCacheOption get ();
    void set (BitmapCacheOption value);
}

JScript

public function get CacheOption () : BitmapCacheOption
public function set CacheOption (value : BitmapCacheOption)

XAML Attribute Usage

<object CacheOption="BitmapCacheOption" .../>

Property Value

Type: System.Windows.Media.Imaging..::.BitmapCacheOption
The BitmapCacheOption being used for the BitmapImage. The default is BitmapCacheOption..::.Default.

Dependency Property Information

Identifier field	CacheOptionProperty
Metadata properties set to true	None

Remarks

Set the CacheOption to BitmapCacheOption..::.OnLoad if you wish to close a stream used to create the BitmapImage. The default OnDemand cache option retains access to the stream until the image is needed, and cleanup is handled by the garbage collector.

Examples

The following code example demonstrates how to set the CacheOption of a BitmapImage by using code.

Visual Basic

' Define a BitmapImage.
Dim myImage As New Image()
Dim bi As New BitmapImage()

' Begin initialization.
bi.BeginInit()

' Set properties.
bi.CacheOption = BitmapCacheOption.OnDemand
bi.CreateOptions = BitmapCreateOptions.DelayCreation
bi.DecodePixelHeight = 125
bi.DecodePixelWidth = 125
bi.Rotation = Rotation.Rotate90
MessageBox.Show(bi.IsDownloading.ToString())
bi.UriSource = New Uri("smiley.png", UriKind.Relative)

' End initialization.
bi.EndInit()
myImage.Source = bi
myImage.Stretch = Stretch.None
myImage.Margin = New Thickness(5)

// Define a BitmapImage.
Image myImage = new Image();
BitmapImage bi = new BitmapImage();

// Begin initialization.
bi.BeginInit();

// Set properties.
bi.CacheOption = BitmapCacheOption.OnDemand;
bi.CreateOptions = BitmapCreateOptions.DelayCreation;
bi.DecodePixelHeight = 125;
bi.DecodePixelWidth = 125;
bi.Rotation = Rotation.Rotate90;
MessageBox.Show(bi.IsDownloading.ToString());
bi.UriSource = new Uri("smiley.png", UriKind.Relative);

// End initialization.
bi.EndInit();
myImage.Source = bi;
myImage.Stretch = Stretch.None;
myImage.Margin = new Thickness(5);

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

BitmapImage Class

BitmapImage Members

System.Windows.Media.Imaging Namespace

BitmapCacheOption