Export (0) Print
Expand All

EnumConverter Class

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

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

[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public class EnumConverter : TypeConverter

The EnumConverter type exposes the following members.

  NameDescription
Public methodEnumConverterInitializes a new instance of the EnumConverter class for the given type.
Top

  NameDescription
Protected propertyComparerGets an IComparer that can be used to sort the values of the enumeration.
Protected propertyEnumTypeSpecifies the type of the enumerator this converter is associated with.
Protected propertyValuesGets or sets a TypeConverter.StandardValuesCollection that specifies the possible values for the enumeration.
Top

  NameDescription
Public methodCanConvertFrom(Type)Returns whether this converter can convert an object of the given type to the type of this converter. (Inherited from TypeConverter.)
Public methodCanConvertFrom(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 TypeConverter.CanConvertFrom(ITypeDescriptorContext, Type).)
Public methodCanConvertTo(Type)Returns whether this converter can convert the object to the specified type. (Inherited from TypeConverter.)
Public methodCanConvertTo(ITypeDescriptorContext, Type)Gets a value indicating whether this converter can convert an object to the given destination type using the context. (Overrides TypeConverter.CanConvertTo(ITypeDescriptorContext, Type).)
Public methodConvertFrom(Object)Converts the given value to the type of this converter. (Inherited from TypeConverter.)
Public methodConvertFrom(ITypeDescriptorContext, CultureInfo, Object)Converts the specified value object to an enumeration object. (Overrides TypeConverter.ConvertFrom(ITypeDescriptorContext, CultureInfo, Object).)
Public methodConvertFromInvariantString(String)Converts the given string to the type of this converter, using the invariant culture. (Inherited from TypeConverter.)
Public methodConvertFromInvariantString(ITypeDescriptorContext, String)Converts the given string to the type of this converter, using the invariant culture and the specified context. (Inherited from TypeConverter.)
Public methodConvertFromString(String)Converts the specified text to an object. (Inherited from TypeConverter.)
Public methodConvertFromString(ITypeDescriptorContext, String)Converts the given text to an object, using the specified context. (Inherited from TypeConverter.)
Public methodConvertFromString(ITypeDescriptorContext, CultureInfo, String)Converts the given text to an object, using the specified context and culture information. (Inherited from TypeConverter.)
Public methodConvertTo(Object, Type)Converts the given value object to the specified type, using the arguments. (Inherited from TypeConverter.)
Public methodConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type)Converts the given value object to the specified destination type. (Overrides TypeConverter.ConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type).)
Public methodConvertToInvariantString(Object)Converts the specified value to a culture-invariant string representation. (Inherited from TypeConverter.)
Public methodConvertToInvariantString(ITypeDescriptorContext, Object)Converts the specified value to a culture-invariant string representation, using the specified context. (Inherited from TypeConverter.)
Public methodConvertToString(Object)Converts the specified value to a string representation. (Inherited from TypeConverter.)
Public methodConvertToString(ITypeDescriptorContext, Object)Converts the given value to a string representation, using the given context. (Inherited from TypeConverter.)
Public methodConvertToString(ITypeDescriptorContext, CultureInfo, Object)Converts the given value to a string representation, using the specified context and culture information. (Inherited from TypeConverter.)
Public methodCreateInstance(IDictionary)Re-creates an Object given a set of property values for the object. (Inherited from TypeConverter.)
Public methodCreateInstance(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 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.)
Protected methodGetConvertFromExceptionReturns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter.)
Protected methodGetConvertToExceptionReturns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter.)
Public methodGetCreateInstanceSupported()Returns whether changing a value on this object requires a call to the CreateInstance method to create a new value. (Inherited from TypeConverter.)
Public methodGetCreateInstanceSupported(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 methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetProperties(Object)Returns a collection of properties for the type of array specified by the value parameter. (Inherited from TypeConverter.)
Public methodGetProperties(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 methodGetProperties(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 methodGetPropertiesSupported()Returns whether this object supports properties. (Inherited from TypeConverter.)
Public methodGetPropertiesSupported(ITypeDescriptorContext)Returns whether this object supports properties, using the specified context. (Inherited from TypeConverter.)
Public methodGetStandardValues()Returns a collection of standard values from the default context for the data type this type converter is designed for. (Inherited from TypeConverter.)
Public methodGetStandardValues(ITypeDescriptorContext)Gets a collection of standard values for the data type this validator is designed for. (Overrides TypeConverter.GetStandardValues(ITypeDescriptorContext).)
Public methodGetStandardValuesExclusive()Returns whether the collection of standard values returned from GetStandardValues is an exclusive list. (Inherited from TypeConverter.)
Public methodGetStandardValuesExclusive(ITypeDescriptorContext)Gets a value indicating whether the list of standard values returned from GetStandardValues is an exclusive list using the specified context. (Overrides TypeConverter.GetStandardValuesExclusive(ITypeDescriptorContext).)
Public methodGetStandardValuesSupported()Returns whether this object supports a standard set of values that can be picked from a list. (Inherited from TypeConverter.)
Public methodGetStandardValuesSupported(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 TypeConverter.GetStandardValuesSupported(ITypeDescriptorContext).)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsValid(Object)Returns whether the given value object is valid for this type. (Inherited from TypeConverter.)
Public methodIsValid(ITypeDescriptorContext, Object)Gets a value indicating whether the given object value is valid for this type. (Overrides TypeConverter.IsValid(ITypeDescriptorContext, Object).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSortPropertiesSorts a collection of properties. (Inherited from TypeConverter.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

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



.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.

Community Additions

ADD
Show:
© 2014 Microsoft