Windows Dev Center

Information
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)
XML Namespace:  http://schemas.microsoft.com/winfx/2006/xaml/presentation

[FlagsAttribute] 
public enum BitmapCreateOptions
/** @attribute FlagsAttribute() */ 
public enum BitmapCreateOptions
FlagsAttribute 
public enum BitmapCreateOptions
<object property="EnumerationValue" .../>

 Member nameDescription
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. 
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. 

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

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions

Show:
© 2015 Microsoft