BitmapImage Class

Article
11/23/2015

[ 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.

Inheritance Hierarchy

System..::.Object
  System.Windows..::.DependencyObject
    System.Windows.Media..::.ImageSource
      System.Windows.Media.Imaging..::.BitmapSource
        System.Windows.Media.Imaging..::.BitmapImage

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

Syntax

Public NotInheritable Class BitmapImage _
    Inherits BitmapSource

public sealed class BitmapImage : BitmapSource

<BitmapImage .../>

The BitmapImage type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	CreateOptions	Gets or sets the BitmapCreateOptions for a BitmapImage.
	DecodePixelHeight	The height of a bitmap image.
	DecodePixelType	Gets or sets the type of the pixel.
	DecodePixelWidth	The width of a bitmap image.
	Dispatcher	Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
	PixelHeight	Gets the height of the bitmap in pixels. (Inherited from BitmapSource.)
	PixelWidth	Gets the width of the bitmap in pixels. (Inherited from BitmapSource.)
	UriSource	Gets or sets the URI of the graphics source file that generated this BitmapImage.

Top

Methods

	Name	Description
	CheckAccess	Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
	ClearValue	Clears the local value of a dependency property. (Inherited from DependencyObject.)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetAnimationBaseValue	Returns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReadLocalValue	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
	SetSource	Sets the source of the BitmapSource. (Inherited from BitmapSource.)
	SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	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.

Top

Fields

	Name	Description
	CreateOptionsProperty	Identifies the CreateOptions dependency property.
	DecodePixelHeightProperty	Identifies the DecodePixelHeight dependency property.
	DecodePixelTypeProperty	Identifies the DecodePixelType dependency property.
	DecodePixelWidthProperty	Identifies the DecodePixelWidth dependency property.
	UriSourceProperty	Identifies the UriSource dependency property.

Top

Remarks

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.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

Thread Safety

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