This documentation is archived and is not being maintained.

BitmapCacheOption Enumeration

Specifies how a bitmap image takes advantage of memory caching.

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

public enum BitmapCacheOption
<object property="enumerationMemberName" .../>

Member nameDescription
DefaultCaches the entire image into memory. This is the default value.
OnDemandCreates a memory store for requested data only. The first request loads the image directly; subsequent requests are filled from the cache.
OnLoadCaches the entire image into memory at load time. All requests for image data are filled from the memory store.
NoneDo not create a memory store. All requests for the image are filled directly by the image file.

The following code example demonstrates how to load a BitmapImage and specify the BitmapCacheOption.


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


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: