Class EnumerationExtensions

Namespace

NuvTools.Common.Enums

Assembly

NuvTools.Common.dll

Helpers to interact with the Enumerations.

public static class EnumerationExtensions

Inheritance

object

EnumerationExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GetDescription(Enum)

Returns the description of enum item. Work with DisplayAttribute or DescriptionAttribute.

public static string GetDescription(this Enum value)

Parameters

value Enum

Enum item.

Returns

string

Enum item description.

GetDisplayAttributes(Enum)

public static DisplayAttribute[]? GetDisplayAttributes(this Enum value)

Parameters

value Enum

Returns

DisplayAttribute[]

GetEnumerator<TUEnum>(Enum)

Returns the enum item description.

public static IEnumDescriptor<TUEnum> GetEnumerator<TUEnum>(this Enum value) where TUEnum : IEquatable<TUEnum>

Parameters

value Enum

Enum item.

Returns

IEnumDescriptor<TUEnum>

Enum item description.

Type Parameters

TUEnum

Id type that should be the same as enum underlyting type.

Exceptions

ArgumentNullException

InvalidCastException

GetGroupName(Enum)

Returns the group name of enum item. Work with DisplayAttribute.

public static string GetGroupName(this Enum value)

Parameters

value Enum

Enum item.

Returns

string

Enum item description.

GetName(Enum)

Returns the name of enum item. Work with DisplayAttribute.

public static string GetName(this Enum value)

Parameters

value Enum

Enum item.

Returns

string

Enum item description.

GetOrder(Enum)

Returns the Order value from DisplayAttribute.

public static int? GetOrder(this Enum value)

Parameters

value Enum

Enum with DisplayAttribute.

Returns

int?

GetPrompt(Enum)

Returns the Order value from DisplayAttribute.

public static string? GetPrompt(this Enum value)

Parameters

value Enum

Enum with DisplayAttribute.

Returns

string

GetShortName(Enum)

Returns the short name of enum item. Work with DisplayAttribute.

public static string GetShortName(this Enum value)

Parameters

value Enum

Enum item.

Returns

string

Enum item description.

GetValueAsString(Enum)

Returns the enum value as string.

public static string GetValueAsString(this Enum value)

Parameters

value Enum

Enum item.

Returns

string

Enum value as string.

IsInGroup(Enum, string)

Checks whether the value belongs to a group.

public static bool IsInGroup(this Enum value, string groupName)

Parameters

value Enum

Enum item.

groupName string

Group name.

Returns

bool

ToListEnumFromSeparatorDelimited(string, Type, char)

Returns the enum list from string with separators.

public static IEnumerable<Enum> ToListEnumFromSeparatorDelimited(this string value, Type enumType, char separator)

Parameters

value string

Value string with enums values separated by delimited char.

enumType Type

Enum type

separator char

Item separator.

Returns

IEnumerable<Enum>

Enum list.

ToListEnumFromSeparatorDelimited<TEnum>(string, char)

Returns the enum list from string with separators.

public static IEnumerable<TEnum> ToListEnumFromSeparatorDelimited<TEnum>(this string value, char separator) where TEnum : Enum

Parameters

value string

Value string with enums values separated by delimited char.

separator char

Item separator.

Returns

IEnumerable<TEnum>

Enum list.

Type Parameters

TEnum

Enum type.

ToStringSeparatorDelimited<TEnum>(IEnumerable<TEnum>, char)

Returns the enum list as string with separators.

public static string ToStringSeparatorDelimited<TEnum>(this IEnumerable<TEnum> list, char separator) where TEnum : Enum

Parameters

list IEnumerable<TEnum>

Enumerate list

separator char

Item separator

Returns

string

List as string with separators.

Type Parameters

TEnum

Enum type