BitmapImage Class

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)

Syntax

'Declaration
Public NotInheritable Class BitmapImage _
    Inherits BitmapSource
public sealed class BitmapImage : BitmapSource
<BitmapImage .../>

The BitmapImage type exposes the following members.

Constructors

  Name Description
Public methodSupported by Silverlight for Windows Phone BitmapImage() Initializes a new instance of the BitmapImage class.
Public methodSupported by Silverlight for Windows Phone BitmapImage(Uri) Initializes a new instance of the BitmapImage class, using the supplied URI.

Top

Properties

  Name Description
Public propertySupported by Silverlight for Windows Phone CreateOptions Gets or sets the BitmapCreateOptions for a BitmapImage.
Public propertySupported by Silverlight for Windows Phone Dispatcher Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertySupported by Silverlight for Windows Phone PixelHeight Gets the height of the bitmap in pixels. (Inherited from BitmapSource.)
Public propertySupported by Silverlight for Windows Phone PixelWidth Gets the width of the bitmap in pixels. (Inherited from BitmapSource.)
Public propertySupported by Silverlight for Windows Phone UriSource Gets or sets the URI of the graphics source file that generated this BitmapImage.

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows Phone CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone 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.)
Public methodSupported by Silverlight for Windows Phone GetAnimationBaseValue Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Protected methodSupported by Silverlight for Windows Phone MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone SetSource Sets the source of the BitmapSource. (Inherited from BitmapSource.)
Public methodSupported by Silverlight for Windows Phone SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public eventSupported by Silverlight for Windows Phone DownloadProgress Occurs when a significant change has occurred in the download progress of the BitmapImage content.
Public eventSupported by Silverlight for Windows Phone ImageFailed Occurs when there is an error associated with image retrieval or format.
Public eventSupported by Silverlight for Windows Phone 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

Extension Methods

  Name Description
Public Extension Method CopyTo(Texture2D) Overloaded. Copies a bitmap image to a texture. (Defined by BitmapSourceExtensions.)
Public Extension Method CopyTo(TextureCube, CubeMapFace) Overloaded. Copies a bitmap image to a cube map face. (Defined by BitmapSourceExtensions.)
Public Extension Method CopyTo(Texture2D, Int32, Nullable<Rectangle>, Int32, Int32) Overloaded. Copies a sub-region of bitmap to a sub-region of the texture. (Defined by BitmapSourceExtensions.)
Public Extension Method CopyTo(TextureCube, CubeMapFace, Int32, Nullable<Rectangle>, Int32, Int32) Overloaded. Copies a sub-region of bitmap to a sub-region of the cube map face. (Defined by BitmapSourceExtensions.)

Top

Fields

  Name Description
Public fieldStatic memberSupported by Silverlight for Windows Phone CreateOptionsProperty Identifies the CreateOptions dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone 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 behavior is that 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

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.

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.