BitmapEncoder BitmapEncoder BitmapEncoder BitmapEncoder Class

Definition

Encodes a collection of BitmapFrame objects to an image stream.

public ref class BitmapEncoder abstract : System::Windows::Threading::DispatcherObject
public abstract class BitmapEncoder : System.Windows.Threading.DispatcherObject
type BitmapEncoder = class
    inherit DispatcherObject
Public MustInherit Class BitmapEncoder
Inherits DispatcherObject
Inheritance
Derived

Examples

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);
Dim stream As New FileStream("empty.tif", FileMode.Create)
Dim encoder As New TiffBitmapEncoder()
Dim myTextBlock As 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)

Remarks

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.

Constructors

BitmapEncoder() BitmapEncoder() BitmapEncoder() BitmapEncoder()

Initializes a new instance of the BitmapEncoder class.

Properties

CodecInfo CodecInfo CodecInfo CodecInfo

Gets information that describes this codec.

ColorContexts ColorContexts ColorContexts ColorContexts

Gets or sets a value that represents the color profile that is associated with this encoder.

Dispatcher Dispatcher Dispatcher Dispatcher

Gets the Dispatcher this DispatcherObject is associated with.

(Inherited from DispatcherObject)
Frames Frames Frames Frames

Gets or sets the individual frames within an image.

Metadata Metadata Metadata Metadata

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

Palette Palette Palette Palette

Gets or sets a value that represents the BitmapPalette of an encoded bitmap.

Preview Preview Preview Preview

Gets or sets a BitmapSource that represents the global preview of a bitmap, if there is one.

Thumbnail Thumbnail Thumbnail Thumbnail

Gets or sets a BitmapSource that represents the global embedded thumbnail.

Methods

CheckAccess() CheckAccess() CheckAccess() CheckAccess()

Determines whether the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)
Create(Guid) Create(Guid) Create(Guid) Create(Guid)

Creates a BitmapEncoder from a Guid that identifies the desired bitmap format.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
Save(Stream) Save(Stream) Save(Stream) Save(Stream)

Encodes a bitmap image to a specified Stream.

ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
VerifyAccess() VerifyAccess() VerifyAccess() VerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)

Applies to

See Also