Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

BitmapImage Class

 

Provides a specialized BitmapSource that is optimized for loading images using Extensible Application Markup Language (XAML).

Namespace:   System.Windows.Media.Imaging
Assembly:  PresentationCore (in PresentationCore.dll)

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.DependencyObject
      System.Windows.Freezable
        System.Windows.Media.Animation.Animatable
          System.Windows.Media.ImageSource
            System.Windows.Media.Imaging.BitmapSource
              System.Windows.Media.Imaging.BitmapImage

public sealed class BitmapImage : BitmapSource, ISupportInitialize, 
	IUriContext

NameDescription
System_CAPS_pubmethodBitmapImage()

Initializes a new instance of the BitmapImage class.

System_CAPS_pubmethodBitmapImage(Uri)

Initializes a new instance of the BitmapImage class by using the supplied Uri.

System_CAPS_pubmethodBitmapImage(Uri, RequestCachePolicy)

Initializes a new instance of the BitmapImage class with an image whose source is a Uri, and is cached according to the provided RequestCachePolicy.

NameDescription
System_CAPS_pubpropertyBaseUri

Gets or sets a value that represents the base Uri of the current BitmapImage context.

System_CAPS_pubpropertyCacheOption

Gets or sets the BitmapCacheOption to use for this instance of BitmapImage.

System_CAPS_pubpropertyCanFreeze

Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)

System_CAPS_pubpropertyCreateOptions

Gets or sets the BitmapCreateOptions for a BitmapImage.

System_CAPS_pubpropertyDecodePixelHeight

Gets or sets the height, in pixels, that the image is decoded to.

System_CAPS_pubpropertyDecodePixelWidth

Gets or sets the width, in pixels, that the image is decoded to.

System_CAPS_pubpropertyDependencyObjectType

Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)

System_CAPS_pubpropertyDispatcher

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubpropertyDpiX

Gets the horizontal dots per inch (dpi) of the image. (Inherited from BitmapSource.)

System_CAPS_pubpropertyDpiY

Gets the vertical dots per inch (dpi) of the image. (Inherited from BitmapSource.)

System_CAPS_pubpropertyFormat

Gets the native PixelFormat of the bitmap data. (Inherited from BitmapSource.)

System_CAPS_pubpropertyHasAnimatedProperties

Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties.(Inherited from Animatable.)

System_CAPS_pubpropertyHeight

Gets the height of the source bitmap in device-independent units (1/96th inch per unit). (Inherited from BitmapSource.)

System_CAPS_pubpropertyIsDownloading

Gets a value that indicates whether the BitmapImage is currently downloading content.(Overrides BitmapSource.IsDownloading.)

System_CAPS_pubpropertyIsFrozen

Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)

System_CAPS_pubpropertyIsSealed

Gets a value that indicates whether this instance is currently sealed (read-only).(Inherited from DependencyObject.)

System_CAPS_pubpropertyMetadata

Not supported. BitmapImage does not support the Metadata property and will throw a NotSupportedException.(Overrides BitmapSource.Metadata.)

System_CAPS_pubpropertyPalette

Gets the color palette of the bitmap, if one is specified. (Inherited from BitmapSource.)

System_CAPS_pubpropertyPixelHeight

Gets the height of the bitmap in pixels. (Inherited from BitmapSource.)

System_CAPS_pubpropertyPixelWidth

Gets the width of the bitmap in pixels. (Inherited from BitmapSource.)

System_CAPS_pubpropertyRotation

Gets or sets the angle that this BitmapImage is rotated to.

System_CAPS_pubpropertySourceRect

Gets or sets the rectangle that is used as the source of the BitmapImage.

System_CAPS_pubpropertyStreamSource

Gets or sets the stream source of the BitmapImage.

System_CAPS_pubpropertyUriCachePolicy

Gets or sets a value that represents the caching policy for images that come from an HTTP source.

System_CAPS_pubpropertyUriSource

Gets or sets the Uri source of the BitmapImage.

System_CAPS_pubpropertyWidth

Gets the width of the bitmap in device-independent units (1/96th inch per unit). (Inherited from BitmapSource.)

NameDescription
System_CAPS_pubmethodApplyAnimationClock(DependencyProperty, AnimationClock)

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.)

System_CAPS_pubmethodApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.(Inherited from Animatable.)

System_CAPS_pubmethodBeginAnimation(DependencyProperty, AnimationTimeline)

Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used.(Inherited from Animatable.)

System_CAPS_pubmethodBeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)

Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)

System_CAPS_pubmethodBeginInit()

Signals the start of the BitmapImage initialization.

System_CAPS_pubmethodCheckAccess()

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethodClearValue(DependencyProperty)

Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethodClearValue(DependencyPropertyKey)

Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)

System_CAPS_pubmethodClone()

Creates a modifiable clone of this BitmapImage, making deep copies of this object's values.

System_CAPS_pubmethodCloneCurrentValue()

Creates a modifiable clone of this BitmapImage object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are.

System_CAPS_pubmethodCoerceValue(DependencyProperty)

Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodCopyPixels(Array, Int32, Int32)

Copies the bitmap pixel data into an array of pixels with the specified stride, starting at the specified offset.(Inherited from BitmapSource.)

System_CAPS_pubmethodCopyPixels(Int32Rect, Array, Int32, Int32)

Copies the bitmap pixel data within the specified rectangle into an array of pixels that has the specified stride starting at the specified offset.(Inherited from BitmapSource.)

System_CAPS_pubmethodCopyPixels(Int32Rect, IntPtr, Int32, Int32)

Copies the bitmap pixel data within the specified rectangle (Inherited from BitmapSource.)

System_CAPS_pubmethodEndInit()

Signals the end of the BitmapImage initialization.

System_CAPS_pubmethodEquals(Object)

Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodFreeze()

Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)

System_CAPS_pubmethodGetAnimationBaseValue(DependencyProperty)

Returns the non-animated value of the specified DependencyProperty.(Inherited from Animatable.)

System_CAPS_pubmethodGetAsFrozen()

Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)

System_CAPS_pubmethodGetCurrentValueAsFrozen()

Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.(Inherited from Freezable.)

System_CAPS_pubmethodGetHashCode()

Gets a hash code for this DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodGetLocalValueEnumerator()

Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetValue(DependencyProperty)

Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)

System_CAPS_pubmethodInvalidateProperty(DependencyProperty)

Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)

System_CAPS_pubmethodReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetCurrentValue(DependencyProperty, Object)

Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyProperty, Object)

Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyPropertyKey, Object)

Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)

System_CAPS_protmethodShouldSerializeProperty(DependencyProperty)

Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.)

System_CAPS_pubmethodToString()

Creates a string representation of this object based on the current culture. (Inherited from ImageSource.)

System_CAPS_pubmethodToString(IFormatProvider)

Creates a string representation of this object based on the IFormatProvider passed in. If the provider is null, the CurrentCulture is used. (Inherited from ImageSource.)

System_CAPS_pubmethodVerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticCacheOptionProperty

Identifies the CacheOption dependency property.

System_CAPS_pubfieldSystem_CAPS_staticCreateOptionsProperty

Identifies the CreateOptions dependency property.

System_CAPS_pubfieldSystem_CAPS_staticDecodePixelHeightProperty

Identifies the DecodePixelHeight dependency property.

System_CAPS_pubfieldSystem_CAPS_staticDecodePixelWidthProperty

Identifies the DecodePixelWidth dependency property.

System_CAPS_pubfieldSystem_CAPS_staticRotationProperty

Identifies the Rotation dependency property.

System_CAPS_pubfieldSystem_CAPS_staticSourceRectProperty

Identifies the SourceRect dependency property.

System_CAPS_pubfieldSystem_CAPS_staticStreamSourceProperty

Identifies the StreamSource dependency property.

System_CAPS_pubfieldSystem_CAPS_staticUriCachePolicyProperty

Identifies the UriCachePolicy dependency property.

System_CAPS_pubfieldSystem_CAPS_staticUriSourceProperty

Identifies the UriSource dependency property.

NameDescription
System_CAPS_pubeventChanged

Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)

System_CAPS_pubeventDecodeFailed

Occurs when the image fails to load, due to a corrupt image header.(Inherited from BitmapSource.)

System_CAPS_pubeventDownloadCompleted

Occurs when the bitmap content has been completely downloaded.(Inherited from BitmapSource.)

System_CAPS_pubeventDownloadFailed

Occurs when the bitmap content failed to download.(Inherited from BitmapSource.)

System_CAPS_pubeventDownloadProgress

Occurs when the download progress of the bitmap content has changed.(Inherited from BitmapSource.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIFormattable.ToString(String, IFormatProvider)

Formats the value of the current instance using the specified format.(Inherited from ImageSource.)

BitmapImage primarily exists to support Extensible Application Markup Language (XAML) syntax and introduces additional properties for bitmap loading that are not defined by BitmapSource.

BitmapImage implements the ISupportInitialize interface to optimize initialization on multiple properties. Property changes can only occur during object initialization. Call BeginInit to signal that initialization has begun and EndInit to signal that initialization has completed. After initialization, property changes are ignored.

BitmapImage objects created using the BitmapImage constructor are automatically initialized and property changes are ignored.

The following code examples demonstrate how to use a BitmapImage in Extensible Application Markup Language (XAML) and code.

// Create the image element.
Image simpleImage = new Image();    
simpleImage.Width = 200;
simpleImage.Margin = new Thickness(5);

// Create source.
BitmapImage bi = new BitmapImage();
// BitmapImage.UriSource must be in a BeginInit/EndInit block.
bi.BeginInit();
bi.UriSource = new Uri(@"/sampleImages/cherries_larger.jpg",UriKind.RelativeOrAbsolute);
bi.EndInit();
// Set the image source.
simpleImage.Source = bi;

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

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

Return to top
Show:
© 2016 Microsoft