Windows Dev Center

BitmapImage.CreateOptions property

Gets or sets the BitmapCreateOptions for a BitmapImage.

Syntax


public BitmapCreateOptions CreateOptions { get; set; }


<BitmapImage CreateOptions="bitmapCreateOptionsMemberName"/>

Property value

Type: BitmapCreateOptions

The BitmapCreateOptions used for this BitmapImage. The default is None. With this default, a BitmapImage uses cached content when it is available. For a BitmapImage that is created by referencing an image source file by URI, the URI controls the internal caching scheme.

Remarks

The other possible value for CreateOptions is BitmapCreateOptions.IgnoreImageCache. You should only use BitmapCreateOptions.IgnoreImageCache in cases where you know that the source image file as retrieved by URI has the potential to change over time. Otherwise, setting CreateOptions to use BitmapCreateOptions.IgnoreImageCache causes all newly retrieved image sources to be decoded again, which can negatively impact performance. BitmapCreateOptions.IgnoreImageCache is typically only used by design tools that directly manipulate an image in a file location and need to enforce that any URI-determined content is always reloaded from the location, not from the cache.

Requirements (Windows 10 device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.UI.Xaml.Media.Imaging
Windows::UI::Xaml::Media::Imaging [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Media.Imaging
Windows::UI::Xaml::Media::Imaging [C++]

Metadata

Windows.winmd

See also

BitmapImage

 

 

Show:
© 2015 Microsoft