BitmapFrame Class

 

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

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

public abstract class BitmapFrame : BitmapSource, IUriContext

NameDescription
System_CAPS_protmethodBitmapFrame()

Initializes a new instance of the BitmapFrame class.

NameDescription
System_CAPS_pubpropertyBaseUri

When overridden in a derived class, gets or sets a value that represents the base Uri of the current context.

System_CAPS_pubpropertyCanFreeze

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

System_CAPS_pubpropertyColorContexts

When overridden in a derived class, gets a collection of ColorContext objects that are associated with this BitmapFrame.

System_CAPS_pubpropertyDecoder

When overridden in a derived class, gets the decoder associated with this instance of BitmapFrame.

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 BitmapSource content is currently downloading. (Inherited from BitmapSource.)

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

Gets the metadata that is associated with this bitmap image. (Inherited from BitmapSource.)

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_pubpropertyThumbnail

When overridden in a derived class, gets the thumbnail image associated with this BitmapFrame.

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_pubmethodCheckAccess()

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

System_CAPS_protmethodCheckIfSiteOfOrigin()

Checks 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.)

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

System_CAPS_protmethodCloneCore(Freezable)

Makes 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.)

System_CAPS_pubmethodCloneCurrentValue()

Creates 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.)

System_CAPS_protmethodCloneCurrentValueCore(Freezable)

Makes 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.)

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_pubmethodSystem_CAPS_staticCreate(BitmapSource)

Creates a new BitmapFrame from a given BitmapSource.

System_CAPS_pubmethodSystem_CAPS_staticCreate(BitmapSource, BitmapSource)

Creates a new BitmapFrame from a given BitmapSource with the specified thumbnail.

System_CAPS_pubmethodSystem_CAPS_staticCreate(BitmapSource, BitmapSource, BitmapMetadata, ReadOnlyCollection<ColorContext>)

Creates a new BitmapFrame from a given BitmapSource with the specified thumbnail, BitmapMetadata, and ColorContext.

System_CAPS_pubmethodSystem_CAPS_staticCreate(Stream)

Creates a new BitmapFrame from a given Stream.

System_CAPS_pubmethodSystem_CAPS_staticCreate(Stream, BitmapCreateOptions, BitmapCacheOption)

Creates a new BitmapFrame from a given Stream with the specified BitmapCreateOptions and BitmapCacheOption.

System_CAPS_pubmethodSystem_CAPS_staticCreate(Uri)

Creates a new BitmapFrame from a given Uri.

System_CAPS_pubmethodSystem_CAPS_staticCreate(Uri, BitmapCreateOptions, BitmapCacheOption)

Creates a BitmapFrame from a given Uri with the specified BitmapCreateOptions and BitmapCacheOption.

System_CAPS_pubmethodSystem_CAPS_staticCreate(Uri, BitmapCreateOptions, BitmapCacheOption, RequestCachePolicy)

Creates a BitmapFrame from a given Uri with the specified BitmapCreateOptions, BitmapCacheOption, and RequestCachePolicy.

System_CAPS_pubmethodSystem_CAPS_staticCreate(Uri, RequestCachePolicy)

Creates a BitmapFrame from a given Uri with the specified RequestCachePolicy.

System_CAPS_pubmethodCreateInPlaceBitmapMetadataWriter()

When overridden in a derived class, creates an instance of InPlaceBitmapMetadataWriter, which can be used to associate metadata with a BitmapFrame.

System_CAPS_protmethodCreateInstance()

Initializes a new instance of the Freezable class. (Inherited from Freezable.)

System_CAPS_protmethodCreateInstanceCore()

When implemented in a derived class, creates a new instance of the Freezable derived class. (Inherited from Freezable.)

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFreeze()

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

System_CAPS_protmethodFreezeCore(Boolean)

Makes an instance of BitmapSource or a derived class immutable.(Inherited from BitmapSource.)

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_protmethodGetAsFrozenCore(Freezable)

Makes this instance a clone of the specified BitmapSource object. (Inherited from BitmapSource.)

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_protmethodGetCurrentValueAsFrozenCore(Freezable)

Makes 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.)

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_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnChanged()

Called when the current Freezable object is modified. (Inherited from Freezable.)

System_CAPS_protmethodOnFreezablePropertyChanged(DependencyObject, DependencyObject)

Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set.(Inherited from Freezable.)

System_CAPS_protmethodOnFreezablePropertyChanged(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.)

System_CAPS_protmethodOnPropertyChanged(DependencyPropertyChangedEventArgs)

Overrides the DependencyObject implementation of OnPropertyChanged to also invoke any Changed handlers in response to a changing dependency property of type Freezable.(Inherited from Freezable.)

System_CAPS_pubmethodReadLocalValue(DependencyProperty)

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

System_CAPS_protmethodReadPreamble()

Ensures 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.)

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

System_CAPS_protmethodWritePostscript()

Raises 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.)

System_CAPS_protmethodWritePreamble()

Verifies 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.)

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

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
Available since 3.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: