This documentation is archived and is not being maintained.

Encoder Class

An Encoder object encapsulates a globally unique identifier (GUID) that identifies the category of an image encoder parameter.

System.Object
  System.Drawing.Imaging.Encoder

Namespace:  System.Drawing.Imaging
Assembly:  System.Drawing (in System.Drawing.dll)

public sealed class Encoder

The Encoder type exposes the following members.

  NameDescription
Public methodEncoderInitializes a new instance of the Encoder class from the specified globally unique identifier (GUID). The GUID specifies an image encoder parameter category.
Top

  NameDescription
Public propertyGuidGets a globally unique identifier (GUID) that identifies an image encoder parameter category.
Top

  NameDescription
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 methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberChrominanceTableAn Encoder object that is initialized with the globally unique identifier for the chrominance table parameter category.
Public fieldStatic memberColorDepthAn Encoder object that is initialized with the globally unique identifier for the color depth parameter category.
Public fieldStatic memberCompressionAn Encoder object that is initialized with the globally unique identifier for the compression parameter category.
Public fieldStatic memberLuminanceTableRepresents an Encoder object that is initialized with the globally unique identifier for the luminance table parameter category.
Public fieldStatic memberQualityGets an Encoder object that is initialized with the globally unique identifier for the quality parameter category.
Public fieldStatic memberRenderMethodRepresents an Encoder object that is initialized with the globally unique identifier for the render method parameter category.
Public fieldStatic memberSaveFlagRepresents an Encoder object that is initialized with the globally unique identifier for the save flag parameter category.
Public fieldStatic memberScanMethodRepresents an Encoder object that is initialized with the globally unique identifier for the scan method parameter category.
Public fieldStatic memberTransformationRepresents an Encoder object that is initialized with the globally unique identifier for the transformation parameter category.
Public fieldStatic memberVersionRepresents an Encoder object that is initialized with the globally unique identifier for the version parameter category.
Top

When you pass a parameter to an image encoder, the parameter is encapsulated in an EncoderParameter object. One of the fields of the EncoderParameter object is a GUID that specifies the category of the parameter. Use the static fields of the Encoder class to retrieve an Encoder that contains parameters of the desired category.

The image encoders that are built into GDI+ receive parameters that belong to several categories. The following table lists all the categories and the GUID associated with each category.

ChrominanceTable

f2e455dc-09b3-4316-8260-676ada32481c

ColorDepth

66087055-ad66-4c7c-9a18-38a2310b8337

Compression

e09d739d-ccd4-44ee-8eba-3fbf8be4fc58

LuminanceTable

edb33bce-0266-4a77-b904-27216099e717

Quality

1d5be4b5-fa4a-452d-9cdd-5db35105e7eb

RenderMethod

6d42c53a-229a-4825-8bb7-5c99e2b9a8b8

SaveFlag

292266fc-ac40-47bf-8cfc-a85b89a655de

ScanMethod

3a4e2661-3109-4e56-8536-42c156e7dcfa

Transformation

8d0eb2d1-a58e-4ea8-aa14-108074b7b6f9

Version

24d18c76-814a-41a4-bf53-1c219cccf797

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, 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.
Show: