Windows apps
Collapse the table of content
Expand the table of content
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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)

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

Member nameDescription
NoneNo BitmapCreateOptions are specified. This is the default value.
PreservePixelFormatEnsures that the PixelFormat a file is stored in is the same as it is loaded to.
DelayCreationCauses a BitmapSource object to delay initialization until it is necessary. This is useful when dealing with collections of images.
IgnoreColorProfileCauses a BitmapSource to ignore an embedded color profile.
IgnoreImageCacheLoads images without using an existing image cache. This option should only be selected when images in a cache need to be refreshed.

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.
Image myImage = new Image();
BitmapImage bi = new BitmapImage();

// Begin initialization.

// Set properties.
bi.CacheOption = BitmapCacheOption.OnDemand;
bi.CreateOptions = BitmapCreateOptions.DelayCreation;
bi.DecodePixelHeight = 125;
bi.DecodePixelWidth = 125;
bi.Rotation = Rotation.Rotate90;
bi.UriSource = new Uri("smiley.png", UriKind.Relative);

// End initialization.
myImage.Source = bi;
myImage.Stretch = Stretch.None;
myImage.Margin = new Thickness(5);

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0
© 2018 Microsoft