BitmapCreateOptions Enumeration
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Specifies initialization options for a bitmap image.
This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.
Namespace: System.Windows.Media.Imaging
Assembly: System.Windows (in System.Windows.dll)
Syntax
'Declaration
<FlagsAttribute> _
Public Enumeration BitmapCreateOptions
[FlagsAttribute]
public enum BitmapCreateOptions
Members
| Member name | Description | |
|---|---|---|
.gif "Supported by Silverlight for Windows Phone") |
None | No initialization options are specified. This is the NOT the default value for the BitmapImage.CreateOptions property in Silverlight or Silverlight for Windows Phone (DelayCreation is the default). |
|
DelayCreation | Causes a BitmapSource object to delay initialization until it is necessary. This is useful when dealing with collections of images. This is the default value of the BitmapImage.CreateOptions property in Silverlight and Silverlight for Windows Phone. |
|
IgnoreImageCache | Initializes images without using an existing image cache. Any existing entries in the image cache are replaced, even if they share the same URI. This option should only be selected when images in a cache need to be refreshed. |
|
BackgroundCreation | Causes a BitmapSource to be initialized as soon as it is declared. This option uses the image cache for previously used URIs. If an image is not in the image cache, the image will be downloaded and decoded on a separate background thread. |
Remarks
When IgnoreImageCache is specified, any existing entries in the image cache are replaced, even if they share the same URI.
Version Notes
Silverlight for the desktop
The BackgroundCreation value is not available for Silverlight for the desktop.
.png "Silverlight for Windows Phone"){kind=icon}
Silverlight for Windows Phone
The BackgroundCreation value is valid for Silverlight for Windows Phone. For an application that targets Silverlight for Windows Phone, if you specify both BackgroundCreation and DelayCreation, the initialization of BitmapSource will be delayed until it is necessary. The initialization will use the image cache for previously used URIs. If an image is not in the image cache, the image will be downloaded and decoded on a separate background thread.
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
See Also