BitmapFrame Class

Represents image data returned by a decoder and accepted by encoders.

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

public abstract class BitmapFrame : BitmapSource, 
	IUriContext

The BitmapFrame type exposes the following members.

  NameDescription
Protected methodBitmapFrameInitializes a new instance of the BitmapFrame class.
Top

  NameDescription
Public propertyBaseUriWhen overridden in a derived class, gets or sets a value that represents the base Uri of the current context.
Public propertyCanFreezeGets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
Public propertyColorContextsWhen overridden in a derived class, gets a collection of ColorContext objects that are associated with this BitmapFrame.
Public propertyDecoderWhen overridden in a derived class, gets the decoder associated with this instance of BitmapFrame.
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 BitmapSource content is currently downloading. (Inherited from BitmapSource.)
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 propertyMetadataGets the metadata that is associated with this bitmap image. (Inherited from BitmapSource.)
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 propertyThumbnailWhen overridden in a derived class, gets the thumbnail image associated with this BitmapFrame.
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 methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Protected methodCheckIfSiteOfOriginChecks whether the bitmap source content is from a known site of origin. This method is used to make sure that pixel copying operations are safe. (Inherited from BitmapSource.)
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 BitmapSource, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. (Inherited from BitmapSource.)
Protected methodCloneCoreMakes this instance a deep copy of the specified BitmapSource. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. (Inherited from BitmapSource.)
Public methodCloneCurrentValueCreates a modifiable clone of this BitmapSource object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. (Inherited from BitmapSource.)
Protected methodCloneCurrentValueCoreMakes this instance a modifiable deep copy of the specified BitmapSource using current property values. Resource references, data bindings, and animations are not copied, but their current values are. (Inherited from BitmapSource.)
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 methodStatic memberCreate(BitmapSource)Creates a new BitmapFrame from a given BitmapSource.
Public methodStatic memberCreate(Stream)Creates a new BitmapFrame from a given Stream.
Public methodStatic memberCreate(Uri)Creates a new BitmapFrame from a given Uri.
Public methodStatic memberCreate(BitmapSource, BitmapSource)Creates a new BitmapFrame from a given BitmapSource with the specified thumbnail.
Public methodStatic memberCreate(Uri, RequestCachePolicy)Creates a BitmapFrame from a given Uri with the specified RequestCachePolicy.
Public methodStatic memberCreate(Stream, BitmapCreateOptions, BitmapCacheOption)Creates a new BitmapFrame from a given Stream with the specified BitmapCreateOptions and BitmapCacheOption.
Public methodStatic memberCreate(Uri, BitmapCreateOptions, BitmapCacheOption)Creates a BitmapFrame from a given Uri with the specified BitmapCreateOptions and BitmapCacheOption.
Public methodStatic memberCreate(BitmapSource, BitmapSource, BitmapMetadata, ReadOnlyCollection<ColorContext>)Creates a new BitmapFrame from a given BitmapSource with the specified thumbnail, BitmapMetadata, and ColorContext.
Public methodStatic memberCreate(Uri, BitmapCreateOptions, BitmapCacheOption, RequestCachePolicy)Creates a BitmapFrame from a given Uri with the specified BitmapCreateOptions, BitmapCacheOption, and RequestCachePolicy.
Public methodCreateInPlaceBitmapMetadataWriterWhen overridden in a derived class, creates an instance of InPlaceBitmapMetadataWriter, which can be used to associate metadata with a BitmapFrame.
Protected methodCreateInstanceInitializes a new instance of the Freezable class. (Inherited from Freezable.)
Protected methodCreateInstanceCoreWhen implemented in a derived class, creates a new instance of the Freezable derived class. (Inherited from Freezable.)
Public methodEqualsDetermines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFreeze()Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
Protected methodFreezeCoreMakes an instance of BitmapSource or a derived class immutable. (Inherited from BitmapSource.)
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.)
Protected methodGetAsFrozenCoreMakes this instance a clone of the specified BitmapSource object. (Inherited from BitmapSource.)
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.)
Protected methodGetCurrentValueAsFrozenCoreMakes this instance a frozen clone of the specified BitmapSource. Resource references, data bindings, and animations are not copied, but their current values are. (Inherited from BitmapSource.)
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.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnChangedCalled when the current Freezable object is modified. (Inherited from Freezable.)
Protected methodOnFreezablePropertyChanged(DependencyObject, DependencyObject)Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable.)
Protected methodOnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from Freezable.)
Protected methodOnPropertyChangedOverrides the DependencyObject implementation of OnPropertyChanged to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable.)
Public methodReadLocalValueReturns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Protected methodReadPreambleEnsures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. (Inherited from Freezable.)
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.)
Protected methodWritePostscriptRaises the Changed event for the Freezable and invokes its OnChanged method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. (Inherited from Freezable.)
Protected methodWritePreambleVerifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable.)
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
Explicit interface implemetationPrivate methodIFormattable.ToStringFormats the value of the current instance using the specified format. (Inherited from ImageSource.)
Top

BitmapFrame provides additional functionality not defined by BitmapSource by providing access to the Thumbnail associated with a particular frame of an image. BitmapFrame also supports the writing of metadata information by using the Metadata property or the CreateInPlaceBitmapMetadataWriter method.

Any BitmapFrame returned from a decoder is always frozen. If you require a modifiable copy, you must first create a copy of the BitmapFrame by using the Clone method.

Only Tagged Image File Format (TIFF) and Graphics Interchange Format (GIF) format images support multiple frames.

The following code example demonstrates how to create a new BitmapSource by using a BitmapFrame.

            int width = 128;
            int height = width;
            int stride = width/8;
            byte[] pixels = new byte[height*stride];

            // Try creating a new image with a custom palette.
            List<System.Windows.Media.Color> colors = new List<System.Windows.Media.Color>();
            colors.Add(System.Windows.Media.Colors.Red);
            colors.Add(System.Windows.Media.Colors.Blue);
            colors.Add(System.Windows.Media.Colors.Green);
            BitmapPalette myPalette = new BitmapPalette(colors);

            // Creates a new empty image with the pre-defined palette

            BitmapSource image = BitmapSource.Create(
                width,
                height,
                96,
                96,
                PixelFormats.Indexed1,
                myPalette, 
                pixels, 
                stride);

            FileStream stream = new FileStream("empty.tif", FileMode.Create);
            TiffBitmapEncoder encoder = new TiffBitmapEncoder();
            TextBlock myTextBlock = new TextBlock();
            myTextBlock.Text = "Codec Author is: " + encoder.CodecInfo.Author.ToString();
            encoder.Frames.Add(BitmapFrame.Create(image));
            MessageBox.Show(myPalette.Colors.Count.ToString());
            encoder.Save(stream);

The following code example demonstrates how to use the BitmapFrame object to open a Portable Network Graphics (PNG) graphic and write metadata by using the CreateInPlaceBitmapMetadataWriter method.

Stream pngStream = new System.IO.FileStream("smiley.png", FileMode.Open, FileAccess.ReadWrite, FileShare.ReadWrite);
PngBitmapDecoder pngDecoder = new PngBitmapDecoder(pngStream, BitmapCreateOptions.PreservePixelFormat, BitmapCacheOption.Default);
BitmapFrame pngFrame = pngDecoder.Frames[0];
InPlaceBitmapMetadataWriter pngInplace = pngFrame.CreateInPlaceBitmapMetadataWriter();
if (pngInplace.TrySave() == true)
{ pngInplace.SetQuery("/Text/Description", "Have a nice day."); }
pngStream.Close();

.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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft