Class EnumDescriptionExtensions

Namespace

HeroKit.Enums

Assembly

HeroKit.dll

Reads display texts of enum values.

public static class EnumDescriptionExtensions

Inheritance

object

EnumDescriptionExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GetDescription<T>(T)

Returns the display text of an enum value from DescriptionAttribute or DisplayAttribute.

public static string GetDescription<T>(this T value) where T : struct, Enum

Parameters

value T

The enum value.

Returns

string

The description, the display name or the member name.

Type Parameters

T

The enum type.

Examples

enum OrderStatus { [Description("Kargoya verildi")] Shipped }
OrderStatus.Shipped.GetDescription(); // "Kargoya verildi"

Remarks

DescriptionAttribute wins over Name. Values without either attribute, and combined flag values, return their name.