BitmapCreateOptions Enumeration

 

Specifies initialization options for bitmap images.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

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

<FlagsAttribute>
Public Enumeration BitmapCreateOptions

Member nameDescription
DelayCreation

Causes a BitmapSource object to delay initialization until it is necessary. This is useful when dealing with collections of images.

IgnoreColorProfile

Causes a BitmapSource to ignore an embedded color profile.

IgnoreImageCache

Loads images without using an existing image cache. This option should only be selected when images in a cache need to be refreshed.

None

No BitmapCreateOptions are specified. This is the default value.

PreservePixelFormat

Ensures that the PixelFormat a file is stored in is the same as it is loaded to.

If PreservePixelFormat is not selected, the PixelFormat of the image is chosen by the system depending on what the system determines will yield the best performance. Enabling this option preserves the file format but may result in lesser performance.

If BitmapCreateOptions is set to IgnoreColorProfile, calls to methods such as CopyPixels(Array, Int32, Int32) will not return color-corrected bits.

When IgnoreImageCache is selected, any existing entries in the image cache are replaced even if they share the same Uri.

The following code example demonstrates how to instantiate a BitmapImage and specify BitmapCreateOptions.

' 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
Silverlight
Available since 3.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: