This documentation is archived and is not being maintained.

BitmapEncoder.Metadata Property

Gets or sets the metadata that will be associated with this bitmap during encoding.

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

public virtual BitmapMetadata Metadata { get; set; }
/** @property */
public BitmapMetadata get_Metadata ()

/** @property */
public void set_Metadata (BitmapMetadata value)

public function get Metadata () : BitmapMetadata

public function set Metadata (value : BitmapMetadata)

You cannot use this property in XAML.

Property Value

An instance of BitmapMetadata.

Exception typeCondition


The encoder does not support global metadata.


The metadata value that is passed to the encoder is a null reference (Nothing in Visual Basic).


An attempt is made to write metadata in an incompatible format.

Bitmap images support and store metadata differently. For more information about the metadata types that are supported for each bitmap, see the BitmapMetadata class.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0