This documentation is archived and is not being maintained.

BmpBitmapEncoder Class

Defines an encoder that is used to encode bitmap (BMP) format images.

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

public sealed class BmpBitmapEncoder : BitmapEncoder

The BmpBitmapEncoder type exposes the following members.

Public methodBmpBitmapEncoderInitializes a new instance of the BmpBitmapEncoder class.

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

Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
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. (Inherited from BitmapEncoder.)
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.)

Bitmap (BMP) format does not support features that are supported by other bitmap formats, including global preview, global thumbnail, global metadata, frame level thumbnails, multiple frames, and frame level metadata.

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

The following examples show how to decode and encode a bitmap (BMP) image using the specific BmpBitmapDecoder and BmpBitmapEncoder objects.

This example demonstrates how to decode a BMP image using a BmpBitmapDecoder from a Uri.

// Open a Uri and decode a BMP image
Uri myUri = new Uri("tulipfarm.bmp", UriKind.RelativeOrAbsolute);
BmpBitmapDecoder decoder2 = new BmpBitmapDecoder(myUri, BitmapCreateOptions.PreservePixelFormat, BitmapCacheOption.Default);
BitmapSource bitmapSource2 = decoder2.Frames[0];

// Draw the Image
Image myImage2 = new Image();
myImage2.Source = bitmapSource2;
myImage2.Stretch = Stretch.None;
myImage2.Margin = new Thickness(20);

This example demonstrates how to encode a BitmapSource into a BMP image using a BmpBitmapEncoder.

            int width = 128;
            int height = width;
            int stride = width / 8;
            byte[] pixels = new byte[height * stride];

            // Try creating a new image with a custom palette.
            List<System.Windows.Media.Color> colors = new List<System.Windows.Media.Color>();
            BitmapPalette myPalette = new BitmapPalette(colors);

            // Creates a new empty image with the pre-defined palette
            BitmapSource image = BitmapSource.Create(

            FileStream stream = new FileStream("new.bmp", FileMode.Create);
            BmpBitmapEncoder encoder = new BmpBitmapEncoder();
            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.