BitmapCacheOption Enum

Definition

Specifies how a bitmap image takes advantage of memory caching.

C#
public enum BitmapCacheOption
Inheritance
BitmapCacheOption

Fields

Name Value Description
Default 0

Caches the entire image into memory. This is the default value.

OnDemand 0

Creates a memory store for requested data only. The first request loads the image directly; subsequent requests are filled from the cache.

OnLoad 1

Caches the entire image into memory at load time. All requests for image data are filled from the memory store.

None 2

Do not create a memory store. All requests for the image are filled directly by the image file.

Examples

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

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

Applies to

Product Versions
.NET Framework 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

See also