Export (0) Print
Expand All

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)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

public sealed class BitmapImage : BitmapSource, 
	ISupportInitialize, IUriContext
<BitmapImage .../>

The BitmapImage type exposes the following members.

  NameDescription
Public methodBitmapImage()Initializes a new instance of the BitmapImage class.
Public methodBitmapImage(Uri)Initializes a new instance of the BitmapImage class by using the supplied Uri.
Public methodBitmapImage(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.
Top

  NameDescription
Public propertyBaseUriGets or sets a value that represents the base Uri of the current BitmapImage context.
Public propertyCacheOptionGets or sets the BitmapCacheOption to use for this instance of BitmapImage.
Public propertyCanFreezeGets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
Public propertyCreateOptionsGets or sets the BitmapCreateOptions for a BitmapImage.
Public propertyDecodePixelHeightGets or sets the height, in pixels, that the image is decoded to.
Public propertyDecodePixelWidthGets or sets the width, in pixels, that the image is decoded to.
Public propertyDependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyDpiXGets the horizontal dots per inch (dpi) of the image.  (Inherited from BitmapSource.)
Public propertyDpiYGets the vertical dots per inch (dpi) of the image.  (Inherited from BitmapSource.)
Public propertyFormatGets the native PixelFormat of the bitmap data. (Inherited from BitmapSource.)
Public propertyHasAnimatedPropertiesGets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable.)
Public propertyHeightGets the height of the source bitmap in device-independent units (1/96th inch per unit).  (Inherited from BitmapSource.)
Public propertyIsDownloadingGets a value that indicates whether the BitmapImage is currently downloading content. (Overrides BitmapSource.IsDownloading.)
Public propertyIsFrozenGets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
Public propertyIsSealedGets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public propertyMetadataNot supported. BitmapImage does not support the Metadata property and will throw a NotSupportedException. (Overrides BitmapSource.Metadata.)
Public propertyPaletteGets the color palette of the bitmap, if one is specified. (Inherited from BitmapSource.)
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 propertyRotationGets or sets the angle that this BitmapImage is rotated to.
Public propertySourceRectGets or sets the rectangle that is used as the source of the BitmapImage.
Public propertyStreamSourceGets or sets the stream source of the BitmapImage.
Public propertyUriCachePolicyGets or sets a value that represents the caching policy for images that come from an HTTP source.
Public propertyUriSourceGets or sets the Uri source of the BitmapImage.
Public propertyWidthGets the width of the bitmap in device-independent units (1/96th inch per unit).  (Inherited from BitmapSource.)
Top

  NameDescription
Public methodApplyAnimationClock(DependencyProperty, AnimationClock)Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
Public methodApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
Public methodBeginAnimation(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.)
Public methodBeginAnimation(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.)
Public methodBeginInitSignals the start of the BitmapImage initialization.
Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public methodClearValue(DependencyProperty)Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public methodCloneCreates a modifiable clone of this BitmapImage, making deep copies of this object's values.
Public methodCloneCurrentValueCreates 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.
Public methodCoerceValueCoerces 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.)
Public methodCopyPixels(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.)
Public methodCopyPixels(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.)
Public methodCopyPixels(Int32Rect, IntPtr, Int32, Int32)Copies the bitmap pixel data within the specified rectangle (Inherited from BitmapSource.)
Public methodEndInitSignals the end of the BitmapImage initialization.
Public methodEqualsDetermines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Public methodFreeze()Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
Public methodGetAnimationBaseValueReturns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.)
Public methodGetAsFrozenCreates 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.)
Public methodGetCurrentValueAsFrozenCreates 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.)
Public methodGetHashCodeGets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public methodGetLocalValueEnumeratorCreates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public methodInvalidatePropertyRe-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Public methodReadLocalValueReturns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Public methodSetCurrentValueSets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
Public methodSetValue(DependencyProperty, Object)Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
Protected methodShouldSerializePropertyReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public methodToString() Creates a string representation of this object based on the current culture. (Inherited from ImageSource.)
Public methodToString(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.)
Public methodVerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top

  NameDescription
Public eventChangedOccurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
Public eventDecodeFailedOccurs when the image fails to load, due to a corrupt image header. (Inherited from BitmapSource.)
Public eventDownloadCompletedOccurs when the bitmap content has been completely downloaded. (Inherited from BitmapSource.)
Public eventDownloadFailedOccurs when the bitmap content failed to download. (Inherited from BitmapSource.)
Public eventDownloadProgressOccurs when the download progress of the bitmap content has changed. (Inherited from BitmapSource.)
Top

  NameDescription
Public fieldStatic memberCacheOptionPropertyIdentifies the CacheOption dependency property.
Public fieldStatic memberCreateOptionsPropertyIdentifies the CreateOptions dependency property.
Public fieldStatic memberDecodePixelHeightPropertyIdentifies the DecodePixelHeight dependency property.
Public fieldStatic memberDecodePixelWidthPropertyIdentifies the DecodePixelWidth dependency property.
Public fieldStatic memberRotationPropertyIdentifies the Rotation dependency property.
Public fieldStatic memberSourceRectPropertyIdentifies the SourceRect dependency property.
Public fieldStatic memberStreamSourcePropertyIdentifies the StreamSource dependency property.
Public fieldStatic memberUriCachePolicyPropertyIdentifies the UriCachePolicy dependency property.
Public fieldStatic memberUriSourcePropertyIdentifies the UriSource dependency property.
Top

  NameDescription
Explicit interface implemetationPrivate methodIFormattable.ToStringFormats the value of the current instance using the specified format. (Inherited from ImageSource.)
Top

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.

<!-- Property Tag XAML Syntax -->
<Image Width="200"  Margin="5" Grid.Column="1" Grid.Row="1" >
   <Image.Source>
      <BitmapImage UriSource="sampleImages/bananas.jpg" />
   </Image.Source>
</Image>
<!-- Property Tag XAML Syntax -->
<Image Width="200"  Margin="5" Grid.Column="1" Grid.Row="1" >
   <Image.Source>
      <BitmapImage UriSource="sampleImages/bananas.jpg" />
   </Image.Source>
</Image>
// 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;

More Code

How to: Apply a Transform to a BitmapImageThis example demonstrates how to apply a Transform to a BitmapImage.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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