This documentation is archived and is not being maintained.

BitmapImage.CacheOption Property

Gets or sets the BitmapCacheOption to use for this instance of BitmapImage.

Namespace: System.Windows.Media.Imaging
Assembly: PresentationCore (in presentationcore.dll)
XML Namespace:  http://schemas.microsoft.com/winfx/2006/xaml/presentation

public BitmapCacheOption CacheOption { get; set; }
/** @property */
public BitmapCacheOption get_CacheOption ()

/** @property */
public void set_CacheOption (BitmapCacheOption value)

public function get CacheOption () : BitmapCacheOption

public function set CacheOption (value : BitmapCacheOption)

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

Property Value

The BitmapCacheOption being used for the BitmapImage. The default is Default.

Set the CacheOption to 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.

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

// 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);

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0
Show: