Class EnumHelper

Namespace

AiDotNet.Helpers

Assembly

AiDotNet.dll

Provides utility methods for working with enumeration types.

public static class EnumHelper

Inheritance

object

EnumHelper

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

For Beginners: This helper class contains methods that make it easier to work with enums in C#.

An enum (short for "enumeration") is a special type in programming that represents a set of named constants. Think of it like a predefined list of options.

For example, if you have an enum for DaysOfWeek, it might contain: Monday, Tuesday, Wednesday, etc.

This helper class provides methods to get all the values from an enum, which can be useful when you need to process all possible options or present them to a user.

Methods

GetEnumValues<T>(string?)

Gets all values from an enum type as a list, with an option to ignore a specific value.

public static List<T> GetEnumValues<T>(string? ignoreName = null) where T : struct

Parameters

ignoreName string

Optional name of an enum value to exclude from the result list.

Returns

List<T>

A list containing all enum values, excluding the ignored value if specified.

Type Parameters

T

The enum type to get values from.

Remarks

For Beginners: This method gives you a list of all the options defined in an enum.

For example, if you have an enum for Colors (Red, Green, Blue), this method would return a list containing Red, Green, and Blue.

You can also choose to leave out one specific option by providing its name in the 'ignoreName' parameter. For instance, if you don't want 'Red' in your list, you could call: GetEnumValues<Colors>("Red")

This is useful when you want to present all options to a user except for certain special ones, or when you need to process all enum values except for specific cases.