Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

EnumConverter Class

Provides a type converter to convert Enum objects to and from various other representations.

Namespace: System.ComponentModel
Assembly: System (in system.dll)

public class EnumConverter : TypeConverter
public class EnumConverter extends TypeConverter
public class EnumConverter extends TypeConverter
Not applicable.

This converter can only convert an enumeration object to and from a string. The EnumConverter class provides the Comparer property to get an IComparer interface that can be used to sort the values of the enumeration. By default, the enumeration values are sorted in the order they appear in the file.

For more information about type converters, see the TypeConverter base class and How to: Implement a Type Converter.

NoteNote:

You should never create an instance of an EnumConverter. Instead, call the GetConverter method of the TypeDescriptor class. For more information, see the examples in the TypeConverter base class.

The HostProtectionAttribute attribute applied to this class has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

Notes to Inheritors: If you want to sort the values into a different order, override the Comparer property.

The following code example converts a variable of type Enum to a string, and vice versa. The example requires that you have declared an Enum called Servers and that it has the following members:

Windows=1, Exchange=2, BizTalk=3
Enum myServer= Servers.Exchange;
string myServerString = "BizTalk";
Console.WriteLine(TypeDescriptor.GetConverter(myServer).ConvertTo(myServer, typeof(string))); 
Console.WriteLine(TypeDescriptor.GetConverter(myServer).ConvertFrom(myServerString));    


Enum myServer = Servers.Exchange;
String myServerString = "BizTalk";
Console.WriteLine(TypeDescriptor.GetConverter(myServer).
    ConvertTo(myServer, String.class.ToType()));
Console.WriteLine(TypeDescriptor.GetConverter(myServer).
    ConvertFrom(myServerString));

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

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

Show:
© 2014 Microsoft