Skip to main content
.NET Framework Class Library
EnumConverter Class

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

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/w087sxab_en-us_VS_110_3_0_0_0_0%]([%$TOPIC/w087sxab_en-us_VS_110_3_0_0_0_1%].LinkDemand, SharedState := True)> _
Public Class EnumConverter _
	Inherits [%$TOPIC/w087sxab_en-us_VS_110_3_0_0_0_2%]
[[%$TOPIC/w087sxab_en-us_VS_110_3_0_1_0_0%]([%$TOPIC/w087sxab_en-us_VS_110_3_0_1_0_1%].LinkDemand, SharedState = true)]
public class EnumConverter : [%$TOPIC/w087sxab_en-us_VS_110_3_0_1_0_2%]
[[%$TOPIC/w087sxab_en-us_VS_110_3_0_2_0_0%]([%$TOPIC/w087sxab_en-us_VS_110_3_0_2_0_1%]::LinkDemand, SharedState = true)]
public ref class EnumConverter : public [%$TOPIC/w087sxab_en-us_VS_110_3_0_2_0_2%]
[<[%$TOPIC/w087sxab_en-us_VS_110_3_0_3_0_0%]([%$TOPIC/w087sxab_en-us_VS_110_3_0_3_0_1%].LinkDemand, SharedState = true)>]
type EnumConverter =  
    class 
        inherit [%$TOPIC/w087sxab_en-us_VS_110_3_0_3_0_2%] 
    end

The EnumConverter type exposes the following members.

Constructors
  NameDescription
Public method EnumConverterInitializes a new instance of the EnumConverter class for the given type.
Top
Properties
  NameDescription
Protected property ComparerGets an IComparer that can be used to sort the values of the enumeration.
Protected property EnumTypeSpecifies the type of the enumerator this converter is associated with.
Protected property ValuesGets or sets a TypeConverterStandardValuesCollection that specifies the possible values for the enumeration.
Top
Methods
  NameDescription
Public method CanConvertFrom(Type)Returns whether this converter can convert an object of the given type to the type of this converter. (Inherited from TypeConverter.)
Public method CanConvertFrom(ITypeDescriptorContext, Type)Gets a value indicating whether this converter can convert an object in the given source type to an enumeration object using the specified context. (Overrides TypeConverterCanConvertFrom(ITypeDescriptorContext, Type).)
Public method CanConvertTo(Type)Returns whether this converter can convert the object to the specified type. (Inherited from TypeConverter.)
Public method CanConvertTo(ITypeDescriptorContext, Type)Gets a value indicating whether this converter can convert an object to the given destination type using the context. (Overrides TypeConverterCanConvertTo(ITypeDescriptorContext, Type).)
Public method ConvertFrom(Object)Converts the given value to the type of this converter. (Inherited from TypeConverter.)
Public method ConvertFrom(ITypeDescriptorContext, CultureInfo, Object)Converts the specified value object to an enumeration object. (Overrides TypeConverterConvertFrom(ITypeDescriptorContext, CultureInfo, Object).)
Public method ConvertFromInvariantString(String)Converts the given string to the type of this converter, using the invariant culture. (Inherited from TypeConverter.)
Public method ConvertFromInvariantString(ITypeDescriptorContext, String)Converts the given string to the type of this converter, using the invariant culture and the specified context. (Inherited from TypeConverter.)
Public method ConvertFromString(String)Converts the specified text to an object. (Inherited from TypeConverter.)
Public method ConvertFromString(ITypeDescriptorContext, String)Converts the given text to an object, using the specified context. (Inherited from TypeConverter.)
Public method ConvertFromString(ITypeDescriptorContext, CultureInfo, String)Converts the given text to an object, using the specified context and culture information. (Inherited from TypeConverter.)
Public method ConvertTo(Object, Type)Converts the given value object to the specified type, using the arguments. (Inherited from TypeConverter.)
Public method ConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type)Converts the given value object to the specified destination type. (Overrides TypeConverterConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type).)
Public method ConvertToInvariantString(Object)Converts the specified value to a culture-invariant string representation. (Inherited from TypeConverter.)
Public method ConvertToInvariantString(ITypeDescriptorContext, Object)Converts the specified value to a culture-invariant string representation, using the specified context. (Inherited from TypeConverter.)
Public method ConvertToString(Object)Converts the specified value to a string representation. (Inherited from TypeConverter.)
Public method ConvertToString(ITypeDescriptorContext, Object)Converts the given value to a string representation, using the given context. (Inherited from TypeConverter.)
Public method ConvertToString(ITypeDescriptorContext, CultureInfo, Object)Converts the given value to a string representation, using the specified context and culture information. (Inherited from TypeConverter.)
Public method CreateInstance(IDictionary)Re-creates an Object given a set of property values for the object. (Inherited from TypeConverter.)
Public method CreateInstance(ITypeDescriptorContext, IDictionary)Creates an instance of the type that this TypeConverter is associated with, using the specified context, given a set of property values for the object. (Inherited from TypeConverter.)
Public method Equals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GetConvertFromExceptionReturns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter.)
Protected method GetConvertToExceptionReturns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter.)
Public method GetCreateInstanceSupportedReturns whether changing a value on this object requires a call to the CreateInstance method to create a new value. (Inherited from TypeConverter.)
Public method GetCreateInstanceSupported(ITypeDescriptorContext)Returns whether changing a value on this object requires a call to CreateInstance to create a new value, using the specified context. (Inherited from TypeConverter.)
Public method GetHashCodeServes as the default hash function. (Inherited from Object.)
Public method GetProperties(Object)Returns a collection of properties for the type of array specified by the value parameter. (Inherited from TypeConverter.)
Public method GetProperties(ITypeDescriptorContext, Object)Returns a collection of properties for the type of array specified by the value parameter, using the specified context. (Inherited from TypeConverter.)
Public method GetProperties(ITypeDescriptorContext, Object, Attribute)Returns a collection of properties for the type of array specified by the value parameter, using the specified context and attributes. (Inherited from TypeConverter.)
Public method GetPropertiesSupportedReturns whether this object supports properties. (Inherited from TypeConverter.)
Public method GetPropertiesSupported(ITypeDescriptorContext)Returns whether this object supports properties, using the specified context. (Inherited from TypeConverter.)
Public method GetStandardValuesReturns a collection of standard values from the default context for the data type this type converter is designed for. (Inherited from TypeConverter.)
Public method GetStandardValues(ITypeDescriptorContext)Gets a collection of standard values for the data type this validator is designed for. (Overrides TypeConverterGetStandardValues(ITypeDescriptorContext).)
Public method GetStandardValuesExclusiveReturns whether the collection of standard values returned from GetStandardValues is an exclusive list. (Inherited from TypeConverter.)
Public method GetStandardValuesExclusive(ITypeDescriptorContext)Gets a value indicating whether the list of standard values returned from GetStandardValues is an exclusive list using the specified context. (Overrides TypeConverterGetStandardValuesExclusive(ITypeDescriptorContext).)
Public method GetStandardValuesSupportedReturns whether this object supports a standard set of values that can be picked from a list. (Inherited from TypeConverter.)
Public method GetStandardValuesSupported(ITypeDescriptorContext)Gets a value indicating whether this object supports a standard set of values that can be picked from a list using the specified context. (Overrides TypeConverterGetStandardValuesSupported(ITypeDescriptorContext).)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsValid(Object)Returns whether the given value object is valid for this type. (Inherited from TypeConverter.)
Public method IsValid(ITypeDescriptorContext, Object)Gets a value indicating whether the given object value is valid for this type. (Overrides TypeConverterIsValid(ITypeDescriptorContext, Object).)
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected method SortPropertiesSorts a collection of properties. (Inherited from TypeConverter.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Remarks

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.

NoteNote

The HostProtectionAttribute attribute applied to this type or member 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.

Examples

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
Dim myServer As Servers = Servers.Exchange
Dim myServerString As string = "BizTalk"
Console.WriteLine(TypeDescriptor.GetConverter(myServer).ConvertTo(myServer, GetType(String))) 
Console.WriteLine(TypeDescriptor.GetConverter(myServer).ConvertFrom(myServerString))	
			
Enum myServer= Servers.Exchange;
string myServerString = "BizTalk";
Console.WriteLine(TypeDescriptor.GetConverter(myServer).ConvertTo(myServer, typeof(string))); 
Console.WriteLine(TypeDescriptor.GetConverter(myServer).ConvertFrom(myServerString));    
// Requires public declaration of the following type. 
// __value enum Servers {Windows=1, Exchange=2, BizTalk=3};
Servers myServer = Servers::Exchange;
String^ myServerString = "BizTalk";
Console::WriteLine( TypeDescriptor::GetConverter( myServer )->ConvertTo( myServer, String::typeid ) );
Console::WriteLine( TypeDescriptor::GetConverter( myServer )->ConvertFrom( myServerString ) );
Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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