Class EnumUtility

This utility class is designed to make enum related operations easier to work with.

Inheritance

System.Object

EnumUtility

Namespace: Cuemon

Assembly: Cuemon.Core.dll

Syntax

public static class EnumUtility

Methods

| Improve this Doc

HasFlag<TEnum>(TEnum, TEnum)

Determines whether one or more bit fields are set in the specified source.

Declaration

public static bool HasFlag<TEnum>(TEnum source, TEnum value)
    where TEnum : struct, IConvertible

Parameters

Type	Name	Description
TEnum	source	The bit field or bit fields to test if set in `value`.
TEnum	value	An enumeration value.

Returns

Type	Description
System.Boolean	`true` if the bit field or bit fields that are set in `source` are also set in the `value`; otherwise, `false`.

Type Parameters

Name	Description
TEnum	The type of the enumeration.

| Improve this Doc

IsStringOf<TEnum>(String)

Determines whether the specified value is an equivalent of TEnum.

Declaration

public static bool IsStringOf<TEnum>(string value)
    where TEnum : struct, IConvertible

Parameters

Type	Name	Description
System.String	value	A string containing the name or value to validate.

Returns

Type	Description
System.Boolean	`true` if the `value` parameter is an equivalent of `TEnum`; otherwise, `false`.

Type Parameters

Name	Description
TEnum	The type of the enumeration to validate.

| Improve this Doc

IsStringOf<TEnum>(String, Boolean)

Determines whether the specified value is an equivalent of TEnum.

Declaration

public static bool IsStringOf<TEnum>(string value, bool ignoreCase)
    where TEnum : struct, IConvertible

Parameters

Type	Name	Description
System.String	value	A string containing the name or value to validate.
System.Boolean	ignoreCase	`true` to ignore case; `false` to regard case.

Returns

Type	Description
System.Boolean	`true` if the `value` parameter is an equivalent of `TEnum`; otherwise, `false`.

Type Parameters

Name	Description
TEnum	The type of the enumeration to validate.

| Improve this Doc

Parse<TEnum>(String)

Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated TEnum.

Declaration

public static TEnum Parse<TEnum>(string value)
    where TEnum : struct, IConvertible

Parameters

Type	Name	Description
System.String	value	A string containing the name or value to convert.

Returns

Type	Description
TEnum	An enum of type `TEnum` whose value is represented by `value`.

Type Parameters

Name	Description
TEnum	The type of the enumeration to convert.

| Improve this Doc

Parse<TEnum>(String, Boolean)

Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated TEnum.

Declaration

public static TEnum Parse<TEnum>(string value, bool ignoreCase)
    where TEnum : struct, IConvertible

Parameters

Type	Name	Description
System.String	value	A string containing the name or value to convert.
System.Boolean	ignoreCase	`true` to ignore case; `false` to regard case.

Returns

Type	Description
TEnum	An enum of type `TEnum` whose value is represented by `value`.

Type Parameters

Name	Description
TEnum	The type of the enumeration to convert.

Exceptions

Type	Condition
System.ArgumentNullException	`value` is null.
TypeArgumentException	`TEnum` does not represents an enumeration.
System.ArgumentException	`value` does not represents an enumeration.

| Improve this Doc

ToEnumerable<TEnum>()

Creates an System.Collections.Generic.IEnumerable<T> sequence from the specified TEnum.

Declaration

public static IEnumerable<KeyValuePair<int, string>> ToEnumerable<TEnum>()
    where TEnum : struct, IConvertible

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.Int32, System.String>>	An System.Collections.Generic.IEnumerable<T> sequence equivalent to `TEnum`.

Type Parameters

Name	Description
TEnum	The type of the enumeration.

| Improve this Doc

ToEnumerable<T, TEnum>()

Creates an System.Collections.Generic.IEnumerable<T> sequence from the specified TEnum.

Declaration

public static IEnumerable<KeyValuePair<T, string>> ToEnumerable<T, TEnum>()
    where T : struct, IConvertible where TEnum : struct, IConvertible

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<T, System.String>>	An System.Collections.Generic.IEnumerable<T> sequence equivalent to `TEnum`.

Type Parameters

Name	Description
T	The integral type of the enumeration.
TEnum	The type of the enumeration.

| Improve this Doc

TryParse<TEnum>(String, out TEnum)

Converts the specified value of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. The return value indicates whether the conversion succeeded.

Declaration

public static bool TryParse<TEnum>(string value, out TEnum result)
    where TEnum : struct, IConvertible

Parameters

Type	Name	Description
System.String	value	A string containing the name or value to convert.
TEnum	result	When this method returns, `result` contains an object of type `TEnum` whose value is represented by `value` if the parse operation succeeds. If the parse operation fails, result contains the default value of the underlying type of `TEnum`.

Returns

Type	Description
System.Boolean	`true` if the `value` parameter was converted successfully; otherwise, `false`.

Type Parameters

Name	Description
TEnum	The type of the enumeration to convert.

| Improve this Doc

TryParse<TEnum>(String, Boolean, out TEnum)

Converts the specified value of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. A parameter specifies whether the operation is case-sensitive. The return value indicates whether the conversion succeeded.

Declaration

public static bool TryParse<TEnum>(string value, bool ignoreCase, out TEnum result)
    where TEnum : struct, IConvertible

Parameters

Type	Name	Description
System.String	value	A string containing the name or value to convert.
System.Boolean	ignoreCase	`true` to ignore case; `false` to regard case.
TEnum	result	When this method returns, `result` contains an object of type `TEnum` whose value is represented by `value` if the parse operation succeeds. If the parse operation fails, result contains the default value of the underlying type of `TEnum`.

Returns

Type	Description
System.Boolean	`true` if the `value` parameter was converted successfully; otherwise, `false`.

Type Parameters

Name	Description
TEnum	The type of the enumeration to convert.