Class EnumDescriptionConverter<T>

Namespace

NanoByte.Common.Values.Design

Assembly

NanoByte.Common.dll

Type converter for Enums annotated with DescriptionAttributes.

public class EnumDescriptionConverter<T> : TypeConverter where T : struct

Type Parameters

T

The type the converter is used for.

Inheritance

object

TypeConverter

EnumDescriptionConverter<T>

Inherited Members

TypeConverter.CanConvertFrom(Type)

TypeConverter.CanConvertTo(Type)

TypeConverter.CanConvertTo(ITypeDescriptorContext, Type)

TypeConverter.ConvertFrom(object)

TypeConverter.ConvertFromInvariantString(string)

TypeConverter.ConvertFromInvariantString(ITypeDescriptorContext, string)

TypeConverter.ConvertFromString(string)

TypeConverter.ConvertFromString(ITypeDescriptorContext, string)

TypeConverter.ConvertFromString(ITypeDescriptorContext, CultureInfo, string)

TypeConverter.ConvertTo(object, Type)

TypeConverter.ConvertToInvariantString(object)

TypeConverter.ConvertToInvariantString(ITypeDescriptorContext, object)

TypeConverter.ConvertToString(object)

TypeConverter.ConvertToString(ITypeDescriptorContext, object)

TypeConverter.ConvertToString(ITypeDescriptorContext, CultureInfo, object)

TypeConverter.CreateInstance(IDictionary)

TypeConverter.CreateInstance(ITypeDescriptorContext, IDictionary)

TypeConverter.GetConvertFromException(object)

TypeConverter.GetConvertToException(object, Type)

TypeConverter.GetCreateInstanceSupported()

TypeConverter.GetCreateInstanceSupported(ITypeDescriptorContext)

TypeConverter.GetProperties(object)

TypeConverter.GetProperties(ITypeDescriptorContext, object)

TypeConverter.GetProperties(ITypeDescriptorContext, object, Attribute[])

TypeConverter.GetPropertiesSupported()

TypeConverter.GetPropertiesSupported(ITypeDescriptorContext)

TypeConverter.GetStandardValues()

TypeConverter.GetStandardValues(ITypeDescriptorContext)

TypeConverter.GetStandardValuesExclusive()

TypeConverter.GetStandardValuesExclusive(ITypeDescriptorContext)

TypeConverter.GetStandardValuesSupported()

TypeConverter.GetStandardValuesSupported(ITypeDescriptorContext)

TypeConverter.IsValid(object)

TypeConverter.IsValid(ITypeDescriptorContext, object)

TypeConverter.SortProperties(PropertyDescriptorCollection, string[])

Extension Methods

BinaryStorage.SaveBinary<T>(T, Stream)

BinaryStorage.SaveBinary<T>(T, string)

JsonStorage.SaveJson<T>(T, Stream)

JsonStorage.SaveJson<T>(T, string)

JsonStorage.ToJsonString<T>(T)

XmlStorage.SaveXml<T>(T, Stream, string?)

XmlStorage.SaveXml<T>(T, string, string?)

XmlStorage.ToXmlString<T>(T, string?)

UpdateUtils.To<T>(T, ref T, Action)

UpdateUtils.To<T>(T, ref T, ref bool)

UpdateUtils.To<T>(T, ref T, ref bool, ref bool)

UpdateUtils.To<TIn, TOut>(TIn, Func<TIn, TOut>)

ConversionUtils.ConvertToString<TType>(TType)

JsonStorage.ReparseAsJson<T>(object)

JsonStorage.ReparseAsJson<T>(object, T)

Examples

Add this attribute to the Enum:

[TypeConverter(typeof(DescriptionEnumConverter<NameOfEnum>))]

Remarks

Description is used as the case-insensitive string representation (falls back to element name).

Methods

CanConvertFrom(ITypeDescriptorContext?, Type)

Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context.

public override bool CanConvertFrom(ITypeDescriptorContext? context, Type sourceType)

Parameters

context ITypeDescriptorContext

An ITypeDescriptorContext that provides a format context.

sourceType Type

A Type that represents the type you want to convert from.

Returns

bool

true if this converter can perform the conversion; otherwise, false.

ConvertFrom(ITypeDescriptorContext?, CultureInfo?, object)

Converts the given object to the type of this converter, using the specified context and culture information.

public override object ConvertFrom(ITypeDescriptorContext? context, CultureInfo? culture, object value)

Parameters

context ITypeDescriptorContext

An ITypeDescriptorContext that provides a format context.

culture CultureInfo

The CultureInfo to use as the current culture.

value object

The object to convert.

Returns

object

An object that represents the converted value.

Exceptions

NotSupportedException

The conversion cannot be performed.

ConvertTo(ITypeDescriptorContext?, CultureInfo?, object?, Type)

Converts the given value object to the specified type, using the specified context and culture information.

public override object ConvertTo(ITypeDescriptorContext? context, CultureInfo? culture, object? value, Type destinationType)

Parameters

context ITypeDescriptorContext

An ITypeDescriptorContext that provides a format context.

culture CultureInfo

A CultureInfo. If null is passed, the current culture is assumed.

value object

The object to convert.

destinationType Type

The Type to convert the value parameter to.

Returns

object

An object that represents the converted value.

Exceptions

ArgumentNullException

The destinationType parameter is null.

NotSupportedException

The conversion cannot be performed.