EnumConverter Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides a type converter to convert Enum objects to and from various other representations.
public ref class EnumConverter : System::ComponentModel::TypeConverterpublic class EnumConverter : System.ComponentModel.TypeConvertertype EnumConverter = class
inherit TypeConverterPublic Class EnumConverter
Inherits TypeConverter- Inheritance
- Derived
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
// 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 ) );
Enum myServer= Servers.Exchange;
string myServerString = "BizTalk";
Console.WriteLine(TypeDescriptor.GetConverter(myServer).ConvertTo(myServer, typeof(string)));
Console.WriteLine(TypeDescriptor.GetConverter(myServer).ConvertFrom(myServerString));
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))
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.
Note
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.
Notes to Inheritors
If you want to sort the values into a different order, override the Comparer property.
Constructors
| EnumConverter(Type) |
Initializes a new instance of the EnumConverter class for the given type. |
Properties
| Comparer |
Gets an IComparer that can be used to sort the values of the enumeration. |
| EnumType |
Specifies the type of the enumerator this converter is associated with. |
| Values |
Gets or sets a TypeConverter.StandardValuesCollection that specifies the possible values for the enumeration. |
Methods
| 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. |
| CanConvertFrom(Type) |
Returns whether this converter can convert an object of the given type to the type of this converter. (Inherited from TypeConverter) |
| CanConvertTo(ITypeDescriptorContext, Type) |
Gets a value indicating whether this converter can convert an object to the given destination type using the context. |
| CanConvertTo(Type) |
Returns whether this converter can convert the object to the specified type. (Inherited from TypeConverter) |
| ConvertFrom(ITypeDescriptorContext, CultureInfo, Object) |
Converts the specified value object to an enumeration object. |
| ConvertFrom(Object) |
Converts the given value to the type of this converter. (Inherited from TypeConverter) |
| ConvertFromInvariantString(ITypeDescriptorContext, String) |
Converts the given string to the type of this converter, using the invariant culture and the specified context. (Inherited from TypeConverter) |
| ConvertFromInvariantString(String) |
Converts the given string to the type of this converter, using the invariant culture. (Inherited from TypeConverter) |
| ConvertFromString(ITypeDescriptorContext, CultureInfo, String) |
Converts the given text to an object, using the specified context and culture information. (Inherited from TypeConverter) |
| ConvertFromString(ITypeDescriptorContext, String) |
Converts the given text to an object, using the specified context. (Inherited from TypeConverter) |
| ConvertFromString(String) |
Converts the specified text to an object. (Inherited from TypeConverter) |
| ConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type) |
Converts the given value object to the specified destination type. |
| ConvertTo(Object, Type) |
Converts the given value object to the specified type, using the arguments. (Inherited from TypeConverter) |
| ConvertToInvariantString(ITypeDescriptorContext, Object) |
Converts the specified value to a culture-invariant string representation, using the specified context. (Inherited from TypeConverter) |
| ConvertToInvariantString(Object) |
Converts the specified value to a culture-invariant string representation. (Inherited from TypeConverter) |
| ConvertToString(ITypeDescriptorContext, CultureInfo, Object) |
Converts the given value to a string representation, using the specified context and culture information. (Inherited from TypeConverter) |
| ConvertToString(ITypeDescriptorContext, Object) |
Converts the given value to a string representation, using the given context. (Inherited from TypeConverter) |
| ConvertToString(Object) |
Converts the specified value to a string representation. (Inherited from TypeConverter) |
| CreateInstance(IDictionary) |
Re-creates an Object given a set of property values for the object. (Inherited from TypeConverter) |
| 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) |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetConvertFromException(Object) |
Returns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter) |
| GetConvertToException(Object, Type) |
Returns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter) |
| GetCreateInstanceSupported() |
Returns whether changing a value on this object requires a call to the CreateInstance(IDictionary) method to create a new value. (Inherited from TypeConverter) |
| GetCreateInstanceSupported(ITypeDescriptorContext) |
Returns whether changing a value on this object requires a call to CreateInstance(IDictionary) to create a new value, using the specified context. (Inherited from TypeConverter) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| 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) |
| 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) |
| GetProperties(Object) |
Returns a collection of properties for the type of array specified by the value parameter. (Inherited from TypeConverter) |
| GetPropertiesSupported() |
Returns whether this object supports properties. (Inherited from TypeConverter) |
| GetPropertiesSupported(ITypeDescriptorContext) |
Returns whether this object supports properties, using the specified context. (Inherited from TypeConverter) |
| GetStandardValues() |
Returns a collection of standard values from the default context for the data type this type converter is designed for. (Inherited from TypeConverter) |
| GetStandardValues(ITypeDescriptorContext) |
Gets a collection of standard values for the data type this validator is designed for. |
| GetStandardValuesExclusive() |
Returns whether the collection of standard values returned from GetStandardValues() is an exclusive list. (Inherited from TypeConverter) |
| GetStandardValuesExclusive(ITypeDescriptorContext) |
Gets a value indicating whether the list of standard values returned from GetStandardValues() is an exclusive list using the specified context. |
| GetStandardValuesSupported() |
Returns whether this object supports a standard set of values that can be picked from a list. (Inherited from TypeConverter) |
| 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. |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| IsValid(ITypeDescriptorContext, Object) |
Gets a value indicating whether the given object value is valid for this type. |
| IsValid(Object) |
Returns whether the given value object is valid for this type. (Inherited from TypeConverter) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| SortProperties(PropertyDescriptorCollection, String[]) |
Sorts a collection of properties. (Inherited from TypeConverter) |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |
