Provides the practical object source type for the Image.Source and ImageBrush.ImageSource properties. You can define a BitmapImage by using a URI that references an image source file, or by calling SetSourceAsync and supplying a stream.
Inheritance
- Object
- DependencyObject
- ImageSource
- BitmapSource
- BitmapImage
Syntax
<BitmapImage .../>
Attributes
- ActivatableAttribute(NTDDI_WIN8)
- ActivatableAttribute(Windows.UI.Xaml.Media.Imaging.IBitmapImageFactory, NTDDI_WIN8)
- MarshalingBehaviorAttribute(Agile)
- StaticAttribute(Windows.UI.Xaml.Media.Imaging.IBitmapImageStatics, NTDDI_WIN8)
- ThreadingAttribute(Both)
- VersionAttribute(NTDDI_WIN8)
- WebHostHiddenAttribute()
Members
The BitmapImage class has these types of members:
Constructors
The BitmapImage class has these constructors.
| Constructor | Description |
|---|---|
| BitmapImage() | Initializes a new instance of the BitmapImage class. |
| BitmapImage(Uri) | Initializes a new instance of the BitmapImage class, using the supplied Uniform Resource Identifier (URI). |
Events
The BitmapImage class has these events.
| Event | Description |
|---|---|
| DownloadProgress | Occurs when a significant change has occurred in the download progress of the BitmapImage content. |
| ImageFailed | Occurs when there is an error associated with image retrieval or format. |
| ImageOpened | Occurs when the image source is downloaded and decoded with no failure. You can use this event to determine the size of an image before rendering it. |
Methods
The BitmapImage class has these methods. It also inherits methods from the Object class.
| Method | Description |
|---|---|
| ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject) |
| GetAnimationBaseValue | Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject) |
| GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject) |
| ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject) |
| SetSource | Sets the source image for a BitmapSource by accessing a stream. Most callers should use SetSourceAsync instead. (Inherited from BitmapSource) |
| SetSourceAsync | Sets the source image for a BitmapSource by accessing a stream and processing the result asynchronously. (Inherited from BitmapSource) |
| SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject) |
Properties
The BitmapImage class has these properties.
| Property | Access type | Description |
|---|---|---|
| Read/write | Gets or sets the BitmapCreateOptions for a BitmapImage. | |
| Read-only | Identifies the CreateOptions dependency property. | |
| Read/write | Gets or sets the height to use for image decoding operations. | |
| Read-only | Identifies the DecodePixelHeight dependency property. | |
| Read/write | Gets or sets the width to use for image decoding operations. | |
| Read-only | Identifies the DecodePixelWidth dependency property. | |
| Read-only | Gets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject) | |
| Read-only | Gets the height of the bitmap in pixels. (Inherited from BitmapSource) | |
| Read-only | Gets the width of the bitmap in pixels. (Inherited from BitmapSource) | |
| Read/write | Gets or sets the Uniform Resource Identifier (URI) of the graphics source file that generated this BitmapImage. | |
| Read-only | Identifies the UriSource dependency property. |
Remarks
A BitmapImage can be sourced from these image file formats:
- Joint Photographic Experts Group (JPEG)
- Portable Network Graphics (PNG)
- bitmap (BMP)
- Graphics Interchange Format (GIF)
- Tagged Image File Format (TIFF)
- JPEG XR
- icons (ICO)
The underlying codec support for image files is supplied by Windows Imaging Component (WIC) API in Windows 8. For more info on specific image formats as documented for the codecs, see Native WIC Codecs. For more info on formats and how to use Uniform Resource Identifiers (URIs) to access image source files that come from app resources, see Quickstart: Image and ImageBrush.
The API for Image, BitmapImage and BitmapSource doesn't include any dedicated methods for encoding and decoding of media formats. All of the encode and decode operations are built-in, and at most will surface aspects of encode or decode as part of event data for load events. If you want to do any special work with image encode or decode, which you might use if your app is doing image conversions or manipulation, you should use the APIs that are available in the Windows.Graphics.Imaging namespace. These imaging APIs can be used by either Windows Store apps built for Windows using C++, C#, or Visual Basic or Windows Store apps using JavaScript. These APIs are also supported by the WIC component of Windows 8.
Requirements
|
Minimum supported client | Windows 8 [Windows Store apps only] |
|---|---|
|
Minimum supported server | Windows Server 2012 [Windows Store apps only] |
|
Namespace |
|
|
Metadata |
|
See also
Build date: 12/4/2012
