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)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
<object CacheOption="BitmapCacheOption" .../>
Property Value
Type: System.Windows.Media.Imaging.BitmapCacheOptionThe BitmapCacheOption being used for the BitmapImage. The default is BitmapCacheOption.Default.
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.
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 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.