This documentation is archived and is not being maintained.

BitmapEncoder Class

Encodes a collection of BitmapFrame objects to an image stream.

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

public abstract class BitmapEncoder : DispatcherObject

The BitmapEncoder type exposes the following members.

Protected methodBitmapEncoderInitializes a new instance of the BitmapEncoder class.

Public propertyCodecInfoGets information that describes this codec.
Public propertyColorContextsGets or sets a value that represents the color profile that is associated with this encoder.
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyFramesGets or sets the individual frames within an image.
Public propertyMetadataGets or sets the metadata that will be associated with this bitmap during encoding.
Public propertyPaletteGets or sets a value that represents the BitmapPalette of an encoded bitmap.
Public propertyPreviewGets or sets a BitmapSource that represents the global preview of a bitmap, if there is one.
Public propertyThumbnailGets or sets a BitmapSource that represents the global embedded thumbnail.

Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public methodStatic memberCreateCreates a BitmapEncoder from a Guid that identifies the desired bitmap format.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
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 methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSaveEncodes a bitmap image to a specified Stream.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodVerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)

A derived codec may also provide support for specialized encoding properties, which are used to determine how a bitmap is encoded. For example, a codec may support specialized compression routines or interlacing of an encoded image.

You can specify multiple frames for any derived encoder, even if the bitmap format only supports one frame. In this case, only the first frame is saved.

The collection of frames can be encoded one at a time to any number of file streams.

Encoding does not work in partial trust. See WPF Partial Trust Security for information on partial trust.

The following example demonstrates how to use the derived TiffBitmapEncoder class to encode an image.

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

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.