BitmapImage Class

BitmapImage Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Provides the practical object source type for the Image.Source and ImageBrush.ImageSource properties.


Namespace:  System.Windows.Media.Imaging
Assembly:  System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.

public sealed class BitmapImage : BitmapSource
<BitmapImage .../>

The BitmapImage type exposes the following members.

Public methodBitmapImage()Initializes a new instance of the BitmapImage class.
Public methodBitmapImage(Uri)Initializes a new instance of the BitmapImage class, using the supplied URI.

Public propertyCreateOptionsGets or sets the BitmapCreateOptions for a BitmapImage.
Public propertyDecodePixelHeightThe height of a bitmap image.
Public propertyDecodePixelTypeGets or sets the type of the pixel.
Public propertyDecodePixelWidthThe width of a bitmap image.
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyPixelHeightGets the height of the bitmap in pixels. (Inherited from BitmapSource.)
Public propertyPixelWidthGets the width of the bitmap in pixels. (Inherited from BitmapSource.)
Public propertyUriSourceGets or sets the URI of the graphics source file that generated this BitmapImage.

Public methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetAnimationBaseValueReturns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSetSourceSets the source of the BitmapSource. (Inherited from BitmapSource.)
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public eventDownloadProgressOccurs when a significant change has occurred in the download progress of the BitmapImage content.
Public eventImageFailedOccurs when there is an error associated with image retrieval or format.
Public eventImageOpenedOccurs 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.

Public fieldStatic memberCreateOptionsPropertyIdentifies the CreateOptions dependency property.
Public fieldStatic memberDecodePixelHeightPropertyIdentifies the DecodePixelHeight dependency property.
Public fieldStatic memberDecodePixelTypePropertyIdentifies the DecodePixelType dependency property.
Public fieldStatic memberDecodePixelWidthPropertyIdentifies the DecodePixelWidth dependency property.
Public fieldStatic memberUriSourcePropertyIdentifies the UriSource dependency property.

The BitmapImage can be used to reference images in the JPEG and PNG file formats.

If the Image.Source property is set to an invalid format, or is specified to a URI that cannot be resolved, then the ImageFailed event is raised.

There are two ways to specify the graphics content for a BitmapImage: by URI, or by stream. You can set with either of these, and the last technique used will specify the content.

XAML usage for BitmapImage as an object element is uncommon, because it would only be appropriate for setting a BitmapImage as the object element within a property element usage for setting Image.Source. More typically you would use Image and use the URI to set Image.Source as an attribute.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

© 2017 Microsoft