BitmapMetadata Class

Definition

Namespace:

System.Windows.Media.Imaging

Assembly:

PresentationCore.dll

Provides support for reading and writing metadata to and from a bitmap image.

public ref class BitmapMetadata : System::Windows::Media::ImageMetadata, System::Collections::Generic::IEnumerable<System::String ^>

public class BitmapMetadata : System.Windows.Media.ImageMetadata, System.Collections.Generic.IEnumerable<string>

type BitmapMetadata = class
    inherit ImageMetadata
    interface seq<string>
    interface IEnumerable

Public Class BitmapMetadata
Inherits ImageMetadata
Implements IEnumerable(Of String)

Inheritance

Object

DispatcherObject

DependencyObject

Freezable

ImageMetadata

BitmapMetadata

Derived

System.Windows.Media.Imaging.InPlaceBitmapMetadataWriter

Implements

IEnumerable<String> IEnumerable

Examples

The following example demonstrates how to write metadata to a Tagged Image File Format (TIFF) image by using the IFD and Exif schemas.

BitmapMetadata tiffMetadata = new BitmapMetadata("tiff");
tiffMetadata.SetQuery("/ifd/{ushort=1000}", 9999);
tiffMetadata.SetQuery("/ifd/{uint=1001}", 23456);
tiffMetadata.SetQuery("/ifd/{uint=1002}", 34567);
tiffMetadata.SetQuery("/ifd/PaddingSchema:padding", (UInt32)4096);
tiffMetadata.SetQuery("/ifd/exif", new BitmapMetadata("exif"));
tiffMetadata.SetQuery("/ifd/exif/PaddingSchema:padding", (UInt32)4096);

Dim tiffMetadata As New BitmapMetadata("tiff")
tiffMetadata.SetQuery("/ifd/{ushort=1000}", 9999)
tiffMetadata.SetQuery("/ifd/{uint=1001}", 23456)
tiffMetadata.SetQuery("/ifd/{uint=1002}", 34567)
tiffMetadata.SetQuery("/ifd/PaddingSchema:padding", CType(4096, UInt32))
tiffMetadata.SetQuery("/ifd/exif", New BitmapMetadata("exif"))
tiffMetadata.SetQuery("/ifd/exif/PaddingSchema:padding", CType(4096, UInt32))

Remarks

Metadata that is associated with an image is data that describes the image but is not necessary to display the image. Each supported bitmap image format handles metadata differently, but the facility for reading and writing metadata is the same.

Windows Presentation Foundation (WPF) supports the following image metadata schemas: Exchangeable image file (Exif), tEXt (PNG Textual Data), image file directory (IFD), International Press Telecommunications Council (IPTC), and Extensible Metadata Platform (XMP).

If a BitmapMetadata is exposed by a BitmapFrame that is obtained by using a BitmapDecoder, it is read-only by default and mutable operations will throw an exception. If it is exposed by a BitmapFrame that wraps another BitmapSource, it is mutable on construction.

The SetQuery and GetQuery methods can be used to construct and read metadata queries.

Constructors

BitmapMetadata(String)

Initializes a new instance of BitmapMetadata for use with the specified image format.

Properties

ApplicationName	Gets or sets a value that identifies the name of the application that was used to construct or alter an image file.
Author	Gets or sets a value that represents the author of an image.
CameraManufacturer	Gets or sets a value that identifies the camera manufacturer that is associated with an image.
CameraModel	Gets or sets a value that identifies the camera model that was used to capture the image.
CanFreeze	Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable)
Comment	Gets or sets a value that represents a comment that is associated with the image file.
Copyright	Gets or sets a value that indicates copyright information that is associated with the image file.
DateTaken	Gets or sets a value that indicates the date that the image was taken.
DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject)
Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject)
Format	Gets a value that identifies the format of the image.
IsFixedSize	Gets a value that determines whether the BitmapMetadata object is a fixed size.
IsFrozen	Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable)
IsReadOnly	Gets a value that indicates whether the metadata that is associated with an image is read-only.
IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject)
Keywords	Gets or sets a collection of keywords that describe the bitmap image.
Location	Gets a value that identifies the base location of the metadata that is associated with an image.
Rating	Gets or sets a value that identifies the image rating.
Subject	Gets or sets a value that indicates the subject matter of the bitmap image.
Title	Gets or sets a value that identifies the title of an image file.

Methods

CheckAccess()	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)
ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject)
ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject)
Clone()	Creates a modifiable clone of this BitmapMetadata, making deep copies of this object's values.
CloneCore(Freezable)	Makes this instance a deep copy of the specified BitmapMetadata.
CloneCurrentValue()	Creates a modifiable clone (deep copy) of the Freezable using its current values. (Inherited from Freezable)
CloneCurrentValueCore(Freezable)	Makes this instance a modifiable deep copy of the specified BitmapMetadata using current property values. Resource references, data bindings, and animations are not copied, but their current values are.
CoerceValue(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)
ContainsQuery(String)	Determines whether a given query string exists within a BitmapMetadata object.
CreateInstance()	Initializes a new instance of the Freezable class. (Inherited from Freezable)
CreateInstanceCore()	An Implementation of CreateInstance().
Equals(Object)	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject)
Freeze()	Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable)
FreezeCore(Boolean)	Makes the Freezable object unmodifiable or tests whether it can be made unmodifiable. (Inherited from Freezable)
GetAsFrozen()	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)
GetAsFrozenCore(Freezable)	Makes this instance a clone of the specified BitmapMetadata object.
GetCurrentValueAsFrozen()	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)
GetCurrentValueAsFrozenCore(Freezable)	Makes this instance a frozen clone of the specified BitmapMetadata. Resource references, data bindings, and animations are not copied, but their current values are.
GetHashCode()	Gets a hash code for this DependencyObject. (Inherited from DependencyObject)
GetLocalValueEnumerator()	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject)
GetQuery(String)	Provides access to a metadata query reader that can extract metadata from a bitmap image file.
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject)
InvalidateProperty(DependencyProperty)	Re-evaluates the effective value for the specified dependency property. (Inherited from DependencyObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnChanged()	Called when the current Freezable object is modified. (Inherited from Freezable)
OnFreezablePropertyChanged(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)
OnFreezablePropertyChanged(DependencyObject, DependencyObject)	Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable)
OnPropertyChanged(DependencyPropertyChangedEventArgs)	Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject)
ReadPreamble()	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)
RemoveQuery(String)	Removes a metadata query from an instance of BitmapMetadata.
SetCurrentValue(DependencyProperty, Object)	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject)
SetQuery(String, Object)	Provides access to a metadata query writer that can write metadata to a bitmap image file.
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject)
SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject)
ShouldSerializeProperty(DependencyProperty)	Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject)
ToString()	Returns a string that represents the current object. (Inherited from Object)
VerifyAccess()	Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)
WritePostscript()	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)
WritePreamble()	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)

Events

Changed

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

Explicit Interface Implementations

IEnumerable.GetEnumerator()	For a description of this member, see GetEnumerator().
IEnumerable<String>.GetEnumerator()	For a description of this member, see GetEnumerator().

Extension Methods

See also

• BitmapSource
• SetQuery(String, Object)
• GetQuery(String)
• Portable Network Graphics Textual Data (tEXt) Specification
• International Press Telecommunications Council (IPTC) Schema Information
• Adobe Extensible Metadata Platform (XMP)
• EXIF (Exchangeable Image File Format) Specification