BitmapCreateOptions Enumeration (System.Windows.Media.Imaging)

Switch View

BitmapCreateOptions Enumeration

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

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)

Syntax

Visual Basic (Declaration)

<FlagsAttribute> _
Public Enumeration BitmapCreateOptions

Visual Basic (Usage)

Dim instance As BitmapCreateOptions

[FlagsAttribute]
public enum BitmapCreateOptions

Visual C++

[FlagsAttribute]
public enum class BitmapCreateOptions

JScript

public enum BitmapCreateOptions

XAML Attribute Usage

<object property="enumerationMemberName" .../>

Members

	Member name	Description
	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.
	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.

Remarks

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.

Examples

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

Visual Basic

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

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

Platforms

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

System.Windows.Media.Imaging Namespace

BitmapImage

BitmapCacheOption

LateBoundBitmapDecoder

Other Resources

Imaging Overview