Export (0) Print
Expand All

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 enum BitmapCreateOptions
<object property="enumerationMemberName" .../>

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

.NET Framework

Supported in: 4.5.3, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft