BitmapEncoder Class
Encodes a collection of BitmapFrame objects to an image stream.
System.Windows.Threading.DispatcherObject
System.Windows.Media.Imaging.BitmapEncoder
System.Windows.Media.Imaging.BmpBitmapEncoder
System.Windows.Media.Imaging.GifBitmapEncoder
System.Windows.Media.Imaging.JpegBitmapEncoder
System.Windows.Media.Imaging.PngBitmapEncoder
System.Windows.Media.Imaging.TiffBitmapEncoder
System.Windows.Media.Imaging.WmpBitmapEncoder
Assembly: PresentationCore (in PresentationCore.dll)
The BitmapEncoder type exposes the following members.
| Name | Description | |
|---|---|---|
|
CodecInfo | Gets information that describes this codec. |
|
|
ColorContexts | Gets or sets a value that represents the color profile that is associated with this encoder. |
|
|
Dispatcher | Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.) |
|
|
Frames | Gets or sets the individual frames within an image. |
|
|
Metadata | Gets or sets the metadata that will be associated with this bitmap during encoding. |
|
|
Palette | Gets or sets a value that represents the BitmapPalette of an encoded bitmap. |
|
|
Preview | Gets or sets a BitmapSource that represents the global preview of a bitmap, if there is one. |
|
|
Thumbnail | Gets or sets a BitmapSource that represents the global embedded thumbnail. |
| Name | Description | |
|---|---|---|
|
CheckAccess | Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) |
|
Create | Creates a BitmapEncoder from a Guid that identifies the desired bitmap format. |
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
Save | Encodes a bitmap image to a specified Stream. |
|
|
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.) |
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(); encoder.Frames.Add(BitmapFrame.Create(image)); MessageBox.Show(myPalette.Colors.Count.ToString()); encoder.Save(stream);
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.
