BitmapCacheOption Enumeration

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Specifies how a bitmap image takes advantage of memory caching.

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

Public Enumeration BitmapCacheOption

Member nameDescription
Default

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

None

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

OnDemand

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

OnLoad

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

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

' 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)

.NET Framework
Available since 3.0
Return to top
Show: