BitmapEncoder Class

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

NameDescription
System_CAPS_protmethodBitmapEncoder()

Initializes a new instance of the BitmapEncoder class.

NameDescription
System_CAPS_pubpropertyCodecInfo

Gets information that describes this codec.

System_CAPS_pubpropertyColorContexts

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

System_CAPS_pubpropertyDispatcher

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubpropertyFrames

Gets or sets the individual frames within an image.

System_CAPS_pubpropertyMetadata

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

System_CAPS_pubpropertyPalette

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

System_CAPS_pubpropertyPreview

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

System_CAPS_pubpropertyThumbnail

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

NameDescription
System_CAPS_pubmethodCheckAccess()

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethodSystem_CAPS_staticCreate(Guid)

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

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodSave(Stream)

Encodes a bitmap image to a specified Stream.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodVerifyAccess()

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

.NET Framework
Available since 3.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft