Este artículo se tradujo automáticamente. Para ver el artículo en inglés, active la casilla Inglés. Además, puede mostrar el texto en inglés en una ventana emergente si mueve el puntero del mouse sobre el texto.
Traducción
Inglés

Clase Enum

 

Publicado: octubre de 2016

Proporciona la clase base para las enumeraciones.

Espacio de nombres:   System
Ensamblado:  mscorlib (en mscorlib.dll)


[SerializableAttribute]
[ComVisibleAttribute(true)]
public abstract class Enum : ValueType, IComparable, IFormattable, 
	IConvertible

NombreDescripción
System_CAPS_protmethodEnum()

Inicializa una nueva instancia de la clase Enum.

NombreDescripción
System_CAPS_pubmethodCompareTo(Object)

Compara esta instancia con un objeto especificado y devuelve una indicación de los valores relativos.

System_CAPS_pubmethodEquals(Object)

Devuelve un valor que indica si esta instancia equivale a un objeto especificado.(Invalida ValueType.Equals(Object)).

System_CAPS_protmethodFinalize()

Permite que un objeto intente liberar recursos y realizar otras operaciones de limpieza antes de ser reclamado por el recolector de basura. (Heredado de Object).

System_CAPS_pubmethodSystem_CAPS_staticFormat(Type, Object, String)

Convierte el valor especificado de un tipo enumerado especificado en la representación de cadena equivalente de acuerdo con el formato especificado.

System_CAPS_pubmethodGetHashCode()

Devuelve el código hash del valor de esta instancia.(Invalida ValueType.GetHashCode()).

System_CAPS_pubmethodSystem_CAPS_staticGetName(Type, Object)

Recupera el nombre de la constante de la enumeración especificada que tiene el valor especificado.

System_CAPS_pubmethodSystem_CAPS_staticGetNames(Type)

Recupera una matriz con los nombres de las constantes de una enumeración especificada.

System_CAPS_pubmethodGetType()

Obtiene el Type de la instancia actual.(Heredado de Object).

System_CAPS_pubmethodGetTypeCode()

Devuelve el código de tipo del tipo subyacente de este miembro de enumeración.

System_CAPS_pubmethodSystem_CAPS_staticGetUnderlyingType(Type)

Devuelve el tipo subyacente de la enumeración especificada.

System_CAPS_pubmethodSystem_CAPS_staticGetValues(Type)

Recupera una matriz con los valores de las constantes de una enumeración especificada.

System_CAPS_pubmethodHasFlag(Enum)

Determina si hay uno o varios campos de bits establecidos en la instancia actual.

System_CAPS_pubmethodSystem_CAPS_staticIsDefined(Type, Object)

Devuelve una indicación en la que se precisa si existe una constante con un valor especificado en una enumeración especificada.

System_CAPS_protmethodMemberwiseClone()

Crea una copia superficial del Object actual.(Heredado de Object).

System_CAPS_pubmethodSystem_CAPS_staticParse(Type, String)

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente.

System_CAPS_pubmethodSystem_CAPS_staticParse(Type, String, Boolean)

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente. Un parámetro especifica si la operación no distingue mayúsculas de minúsculas.

System_CAPS_pubmethodSystem_CAPS_staticToObject(Type, Byte)

Convierte el entero de 8 bits sin signo especificado en un miembro de enumeración.

System_CAPS_pubmethodSystem_CAPS_staticToObject(Type, Int16)

Convierte el entero de 16 bits con signo especificado en un miembro de enumeración.

System_CAPS_pubmethodSystem_CAPS_staticToObject(Type, Int32)

Convierte el entero de 32 bits con signo especificado en un miembro de enumeración.

System_CAPS_pubmethodSystem_CAPS_staticToObject(Type, Int64)

Convierte el entero de 64 bits con signo especificado en un miembro de enumeración.

System_CAPS_pubmethodSystem_CAPS_staticToObject(Type, Object)

Convierte el objeto especificado con un valor entero en un miembro de enumeración.

System_CAPS_pubmethodSystem_CAPS_staticToObject(Type, SByte)

Convierte el valor entero de 8 bits con signo especificado en un miembro de enumeración.

System_CAPS_pubmethodSystem_CAPS_staticToObject(Type, UInt16)

Convierte el valor entero de 16 bits sin signo especificado en un miembro de enumeración.

System_CAPS_pubmethodSystem_CAPS_staticToObject(Type, UInt32)

Convierte el valor entero de 32 bits sin signo especificado en un miembro de enumeración.

System_CAPS_pubmethodSystem_CAPS_staticToObject(Type, UInt64)

Convierte el valor entero de 64 bits sin signo especificado en un miembro de enumeración.

System_CAPS_pubmethodToString()

Convierte el valor de esta instancia en la representación de cadena equivalente.(Invalida ValueType.ToString()).

System_CAPS_pubmethodToString(IFormatProvider)

Obsoleto. Esta sobrecarga del método está en desuso; use Enum.ToString().

System_CAPS_pubmethodToString(String)

Convierte el valor de esta instancia en la representación de cadena equivalente usando el formato especificado.

System_CAPS_pubmethodToString(String, IFormatProvider)

Obsoleto. Esta sobrecarga del método está en desuso; use Enum.ToString(String).

System_CAPS_pubmethodSystem_CAPS_staticTryParse<TEnum>(String, TEnum)

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente. El valor devuelto indica si la conversión se realizó correctamente.

System_CAPS_pubmethodSystem_CAPS_staticTryParse<TEnum>(String, Boolean, TEnum)

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente. Un parámetro especifica si la operación distingue mayúsculas de minúsculas. El valor devuelto indica si la conversión se realizó correctamente.

NombreDescripción
System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToBoolean(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en un valor booleano basado en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToByte(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en un entero de 8 bits sin signo basado en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToChar(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en un carácter Unicode basado en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToDateTime(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en DateTime basado en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToDecimal(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en Decimal basado en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToDouble(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en número de punto flotante de precisión doble basado en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToInt16(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en un entero de 16 bits con signo basado en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToInt32(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en un entero de 32 bits con signo basado en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToInt64(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en un entero de 64 bits con signo basado en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToSByte(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en un entero de 8 bits con signo basado en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToSingle(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en un número de punto flotante de precisión sencilla basándose en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToType(Type, IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en un tipo especificado basado en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToUInt16(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en un entero de 16 bits sin signo basado en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToUInt32(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en un entero de 32 bits sin signo basado en el tipo subyacente.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIConvertible.ToUInt64(IFormatProvider)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Convierte el valor actual en un entero de 64 bits sin signo basado en el tipo subyacente.

An enumeration is a set of named constants whose underlying type is any integral type. If no underlying type is explicitly declared, T:System.Int32 is used. T:System.Enum is the base class for all enumerations in the .NET Framework. Enumeration types are defined by the enum keyword in C# and the Enum...End Enum construct in Visual Basic.

Enum provides methods for comparing instances of this class, converting the value of an instance to its string representation, converting the string representation of a number to an instance of this class, and creating an instance of a specified enumeration and value.

You can also treat an enumeration as a bit field. For more information, see the Non-Exclusive Members and the Flags Attribute section and the T:System.FlagsAttribute topic.

In this topic:

Creating an enumeration type
Instantiating an enumeration type
Enumeration best practices
Performing operations with enumerations
      Performing conversions
      Parsing enumeration values
      Formatting enumeration values
Iterating enumeration members
Non-exclusive members and the Flags attribute
Adding enumeration methods

Programming languages typically provide syntax to declare an enumeration that consists of a set of named constants and their values. The following example illustrates the syntax used by C# and Visual Basic to define an enumeration. It creates an enumeration named ArrivalStatus that has three members: ArrivalStatus.Early, ArrivalStatus.OnTime, and ArrivalStatus.Late. Note that in both cases, the enumeration does not explicitly inherit from T:System.Enum; the inheritance relationship is handled implicitly by the compiler.

public enum ArrivalStatus { Late=-1, OnTime=0, Early=1 };
System_CAPS_warningAdvertencia

You should never create an enumeration type whose underlying type is non-integral or T:System.Char. Although you can create such an enumeration type by using reflection, method calls that use the resulting type are unreliable and may also throw additional exceptions.

You can instantiate an enumeration type just as you instantiate any other value type: by declaring a variable and assigning one of the enumeration's constants to it. The following example instantiates an ArrivalStatus whose value is ArrivalStatus.OnTime.

public class Example
{
   public static void Main()
   {
      ArrivalStatus status = ArrivalStatus.OnTime;
      Console.WriteLine("Arrival Status: {0} ({0:D})", status);
   }
}
// The example displays the following output:
//       Arrival Status: OnTime (0)

You can also instantiate an enumeration value in the following ways:

  • By using a particular programming language's features to cast (as in C#) or convert (as in Visual Basic) an integer value to an enumeration value. The following example creates an ArrivalStatus object whose value is ArrivalStatus.Early in this way.

    ArrivalStatus status2 = (ArrivalStatus) 1;
    Console.WriteLine("Arrival Status: {0} ({0:D})", status2);
    // The example displays the following output:
    //       Arrival Status: Early (1)
    
  • By calling its implicit default constructor. As the following example shows, in this case the underlying value of the enumeration instance is 0. However, this is not necessarily the value of a valid constant in the enumeration.

    ArrivalStatus status1 = new ArrivalStatus();
    Console.WriteLine("Arrival Status: {0} ({0:D})", status1);
    // The example displays the following output:
    //       Arrival Status: OnTime (0)
    
  • By calling the M:System.Enum.Parse(System.Type,System.String) or M:System.Enum.TryParse``1(System.String,``0@) method to parse a string that contains the name of a constant in the enumeration. For more information, see the Parsing Enumeration Values section.

  • By calling the M:System.Enum.ToObject(System.Type,System.Byte) method to convert an integral value to an enumeration type. For more information, see the Performing Conversions section.

We recommend that you use the following best practices when you define enumeration types:

  • If you have not defined an enumeration member whose value is 0, consider creating a None enumerated constant. By default, the memory used for the enumeration is initialized to zero by the common language runtime. Consequently, if you do not define a constant whose value is zero, the enumeration will contain an illegal value when it is created.

  • If there is an obvious default case that your application has to represent, consider using an enumerated constant whose value is zero to represent it. If there is no default case, consider using an enumerated constant whose value is zero to specify the case that is not represented by any of the other enumerated constants.

  • Do not specify enumerated constants that are reserved for future use.

  • When you define a method or property that takes an enumerated constant as a value, consider validating the value. The reason is that you can cast a numeric value to the enumeration type even if that numeric value is not defined in the enumeration.

Additional best practices for enumeration types whose constants are bit fields are listed in the Non-Exclusive Members and the Flags Attribute section.

You cannot define new methods when you are creating an enumeration. However, an enumeration type inherits a complete set of static and instance methods from the T:System.Enum class. The following sections survey most of these methods, in addition to several other methods that are commonly used when working with enumeration values.

You can convert between an enumeration member and its underlying type by using a casting (in C#) or conversion (in Visual Basic) operator. The following example uses casting or conversion operators to perform conversions both from an integer to an enumeration value and from an enumeration value to an integer.

int value3 = 2;
ArrivalStatus status3 = (ArrivalStatus) value3;

int value4 = (int) status3;

The T:System.Enum class also includes a M:System.Enum.ToObject(System.Type,System.Byte) method that converts a value of any integral type to an enumeration value. The following example uses the M:System.Enum.ToObject(System.Type,System.Int32) method to convert an T:System.Int32 to an ArrivalStatus value. Note that, because the M:System.Enum.ToObject(System.Type,System.Byte) returns a value of type T:System.Object, the use of a casting or conversion operator may still be necessary to cast the object to the enumeration type.

int number = -1;
ArrivalStatus arrived = (ArrivalStatus) ArrivalStatus.ToObject(typeof(ArrivalStatus), number);

When converting an integer to an enumeration value, it is possible to assign a value that is not actually a member of the enumeration. To prevent this, you can pass the integer to the M:System.Enum.IsDefined(System.Type,System.Object) method before performing the conversion. The following example uses this method to determine whether the elements in an array of integer values can be converted to ArrivalStatus values.

using System;

public enum ArrivalStatus { Unknown=-3, Late=-1, OnTime=0, Early=1 };

public class Example
{
   public static void Main()
   {
      int[] values = { -3, -1, 0, 1, 5, Int32.MaxValue };
      foreach (var value in values)
      {
         ArrivalStatus status;
         if (Enum.IsDefined(typeof(ArrivalStatus), value))
            status = (ArrivalStatus) value;
         else
            status = ArrivalStatus.Unknown;
         Console.WriteLine("Converted {0:N0} to {1}", value, status);
      }
   }
}
// The example displays the following output:
//       Converted -3 to Unknown
//       Converted -1 to Late
//       Converted 0 to OnTime
//       Converted 1 to Early
//       Converted 5 to Unknown
//       Converted 2,147,483,647 to Unknown

Although the T:System.Enum class provides explicit interface implementations of the T:System.IConvertible interface for converting from an enumeration value to an integral type, you should use the methods of the T:System.Convert class, such as M:System.Convert.ToInt32(System.Object), to perform these conversions. The following example illustrates how you can use the M:System.Enum.GetUnderlyingType(System.Type) method along with the M:System.Convert.ChangeType(System.Object,System.Type) method to convert an enumeration value to its underlying type. Note that this example does not require the underlying type of the enumeration to be known at compile time.

ArrivalStatus status = ArrivalStatus.Early;
var number = Convert.ChangeType(status, Enum.GetUnderlyingType(typeof(ArrivalStatus)));
Console.WriteLine("Converted {0} to {1}", status, number);
// The example displays the following output:
//       Converted Early to 1

The M:System.Enum.Parse(System.Type,System.String) and M:System.Enum.TryParse``1(System.String,``0@) methods allow you to convert the string representation of an enumeration value to that value. The string representation can be either the name or the underlying value of an enumeration constant. Note that the parsing methods will successfully convert string representations of numbers that are not members of a particular enumeration if the strings can be converted to a value of the enumeration's underlying type. To prevent this, the M:System.Enum.IsDefined(System.Type,System.Object) method can be called to ensure that the result of the parsing method is a valid enumeration value. The example illustrates this approach and demonstrates calls to both the M:System.Enum.Parse(System.Type,System.String) and M:System.Enum.TryParse``1(System.String,``0@) methods. Note that the non-generic parsing method returns an object that you may have to cast (in C#) or convert (in Visual Basic) to the appropriate enumeration type.

string number = "-1";
string name = "Early";

try {
   ArrivalStatus status1 = (ArrivalStatus) Enum.Parse(typeof(ArrivalStatus), number);
   if (!(Enum.IsDefined(typeof(ArrivalStatus), status1)))
      status1 = ArrivalStatus.Unknown;
   Console.WriteLine("Converted '{0}' to {1}", number, status1);
}
catch (FormatException) {
   Console.WriteLine("Unable to convert '{0}' to an ArrivalStatus value.", 
                     number);
}   

ArrivalStatus status2;
if (Enum.TryParse<ArrivalStatus>(name, out status2)) {
   if (!(Enum.IsDefined(typeof(ArrivalStatus), status2)))
      status2 = ArrivalStatus.Unknown;
   Console.WriteLine("Converted '{0}' to {1}", name, status2);
}
else {
   Console.WriteLine("Unable to convert '{0}' to an ArrivalStatus value.", 
                     number);
}
// The example displays the following output:
//       Converted '-1' to Late
//       Converted 'Early' to Early

You can convert enumeration values to their string representations by calling the static M:System.Enum.Format(System.Type,System.Object,System.String) method, as well as the overloads of the instance M:System.Enum.ToString method. You can use a format string to control the precise way in which an enumeration value is represented as a string. For more information, see Enumeration Format Strings. The following example uses each of the supported enumeration format strings ("G" or "g", "D" or "d", "X" or "x", and "F" or "f" ) to convert a member of the ArrivalStatus enumeration to its string representations.

string[] formats= { "G", "F", "D", "X"};
ArrivalStatus status = ArrivalStatus.Late;
foreach (var fmt in formats)
   Console.WriteLine(status.ToString(fmt));

// The example displays the following output:
//       Late
//       Late
//       -1
//       FFFFFFFF

The T:System.Enum type does not implement the T:System.Collections.IEnumerable or T:System.Collections.Generic.IEnumerable`1 interface, which would enable you to iterate members of a collection by using a foreach (in C#) or For Each (in Visual Basic) construct. However, you can enumerate members in either of two ways.

  • You can call the M:System.Enum.GetNames(System.Type) method to retrieve a string array containing the names of the enumeration members. Next, for each element of the string array, you can call the M:System.Enum.Parse(System.Type,System.String) method to convert the string to its equivalent enumeration value. The following example illustrates this approach.

    string[] names = Enum.GetNames(typeof(ArrivalStatus));
    Console.WriteLine("Members of {0}:", typeof(ArrivalStatus).Name);
    Array.Sort(names);
    foreach (var name in names) {
       ArrivalStatus status = (ArrivalStatus) Enum.Parse(typeof(ArrivalStatus), name);
       Console.WriteLine("   {0} ({0:D})", status);
    }
    // The example displays the following output:
    //       Members of ArrivalStatus:
    //          Early (1)
    //          Late (-1)
    //          OnTime (0)
    //          Unknown (-3)      
    
  • You can call the M:System.Enum.GetValues(System.Type) method to retrieve an array that contains the underlying values in the enumeration. Next, for each element of the array, you can call the M:System.Enum.ToObject(System.Type,System.Int32) method to convert the integer to its equivalent enumeration value. The following example illustrates this approach.

    var values = Enum.GetValues(typeof(ArrivalStatus));
    Console.WriteLine("Members of {0}:", typeof(ArrivalStatus).Name);
    foreach (var value in values) {
       ArrivalStatus status = (ArrivalStatus) Enum.ToObject(typeof(ArrivalStatus), value);
       Console.WriteLine("   {0} ({0:D})", status);
    }                                       
    // The example displays the following output:
    //       Members of ArrivalStatus:
    //          OnTime (0)
    //          Early (1)
    //          Unknown (-3)
    //          Late (-1)
    

One common use of an enumeration is to represent a set of mutually exclusive values. For example, an ArrivalStatus instance can have a value of Early, OnTime, or Late. It makes no sense for the value of an ArrivalStatus instance to reflect more than one enumeration constant.

In other cases, however, the value of an enumeration object can include multiple enumeration members, and each member represents a bit field in the enumeration value. The T:System.FlagsAttribute attribute can be used to indicate that the enumeration consists of bit fields. For example, an enumeration named Pets might be used to indicate the kinds of pets in a household. It can be defined as follows.

[Flags] public enum Pets { None=0, Dog=1, Cat=2, Bird=4, Rodent=8,
                           Reptile=16, Other=32 };

The Pets enumeration can then be used as shown in the following example.

Pets familyPets = Pets.Dog | Pets.Cat;
Console.WriteLine("Pets: {0:G} ({0:D})", familyPets);
// The example displays the following output:
//       Pets: Dog, Cat (3)      

The following best practices should be used when defining a bitwise enumeration and applying the T:System.FlagsAttribute attribute.

  • Use the T:System.FlagsAttribute custom attribute for an enumeration only if a bitwise operation (AND, OR, EXCLUSIVE OR) is to be performed on a numeric value.

  • Define enumeration constants in powers of two, that is, 1, 2, 4, 8, and so on. This means the individual flags in combined enumeration constants do not overlap.

  • Consider creating an enumerated constant for commonly used flag combinations. For example, if you have an enumeration used for file I/O operations that contains the enumerated constants Read = 1 and Write = 2, consider creating the enumerated constant ReadWrite = Read OR Write, which combines the Read and Write flags. In addition, the bitwise OR operation used to combine the flags might be considered an advanced concept in some circumstances that should not be required for simple tasks.

  • Use caution if you define a negative number as a flag enumerated constant because many flag positions might be set to 1, which might make your code confusing and encourage coding errors.

  • A convenient way to test whether a flag is set in a numeric value is to call the instance M:System.Enum.HasFlag(System.Enum) method, as shown in the following example.

    Pets familyPets = Pets.Dog | Pets.Cat;
    if (familyPets.HasFlag(Pets.Dog))
       Console.WriteLine("The family has a dog.");
    // The example displays the following output:
    //       The family has a dog.      
    

    It is equivalent to performing a bitwise AND operation between the numeric value and the flag enumerated constant, which sets all bits in the numeric value to zero that do not correspond to the flag, and then testing whether the result of that operation is equal to the flag enumerated constant. This is illustrated in the following example.

    Pets familyPets = Pets.Dog | Pets.Cat;
    if ((familyPets & Pets.Dog) == Pets.Dog)
       Console.WriteLine("The family has a dog.");
    // The example displays the following output:
    //       The family has a dog.      
    
  • Use None as the name of the flag enumerated constant whose value is zero. You cannot use the None enumerated constant in a bitwise AND operation to test for a flag because the result is always zero. However, you can perform a logical, not a bitwise, comparison between the numeric value and the None enumerated constant to determine whether any bits in the numeric value are set. This is illustrated in the following example.

    Pets familyPets = Pets.Dog | Pets.Cat;
    if (familyPets == Pets.None)
       Console.WriteLine("The family has no pets.");
    else
       Console.WriteLine("The family has pets.");   
    // The example displays the following output:
    //       The family has pets.      
    
  • Do not define an enumeration value solely to mirror the state of the enumeration itself. For example, do not define an enumerated constant that merely marks the end of the enumeration. If you need to determine the last value of the enumeration, check for that value explicitly. In addition, you can perform a range check for the first and last enumerated constant if all values within the range are valid.

Because enumeration types are defined by language structures, such as enum (C#) and Enum (Visual Basic), you cannot define custom methods for an enumeration type other than those methods inherited from the T:System.Enum class. However, you can use extension methods to add functionality to a particular enumeration type.

In the following example, the Grades enumeration represents the possible letter grades that a student may receive in a class. An extension method named Passing is added to the Grades type so that each instance of that type now "knows" whether it represents a passing grade or not. The Extensions class also contains a static read-write variable that defines the minimum passing grade. The return value of the Passing extension method reflects the current value of that variable.

using System;

// Define an enumeration to represent student grades.
public enum Grades { F = 0, D = 1, C = 2, B = 3, A = 4 };

// Define an extension method for the Grades enumeration.
public static class Extensions
{        
  public static Grades minPassing = Grades.D;

  public static bool Passing(this Grades grade)
  {
      return grade >= minPassing;
  }
}

class Example
{       
  static void Main()
  {
      Grades g1 = Grades.D;
      Grades g2 = Grades.F;
      Console.WriteLine("{0} {1} a passing grade.", g1, g1.Passing() ? "is" : "is not");
      Console.WriteLine("{0} {1} a passing grade.", g2, g2.Passing() ? "is" : "is not");

      Extensions.minPassing = Grades.C;
      Console.WriteLine("\nRaising the bar!\n");
      Console.WriteLine("{0} {1} a passing grade.", g1, g1.Passing() ? "is" : "is not");
      Console.WriteLine("{0} {1} a passing grade.", g2, g2.Passing() ? "is" : "is not");
  }
}
// The exmaple displays the following output:
//       D is a passing grade.
//       F is not a passing grade.
//       
//       Raising the bar!
//       
//       D is not a passing grade.
//       F is not a passing grade.

The following example demonstrates using an enumeration to represent named values and another enumeration to represent named bit fields.

using System;

public class EnumTest {
    enum Days { Saturday, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday };
    enum BoilingPoints { Celsius = 100, Fahrenheit = 212 };
    [FlagsAttribute]
    enum Colors { Red = 1, Green = 2, Blue = 4, Yellow = 8 };

    public static void Main() {

        Type weekdays = typeof(Days);
        Type boiling = typeof(BoilingPoints);

        Console.WriteLine("The days of the week, and their corresponding values in the Days Enum are:");

        foreach ( string s in Enum.GetNames(weekdays) )
            Console.WriteLine( "{0,-11}= {1}", s, Enum.Format( weekdays, Enum.Parse(weekdays, s), "d"));

        Console.WriteLine();
        Console.WriteLine("Enums can also be created which have values that represent some meaningful amount.");
        Console.WriteLine("The BoilingPoints Enum defines the following items, and corresponding values:");

        foreach ( string s in Enum.GetNames(boiling) )
            Console.WriteLine( "{0,-11}= {1}", s, Enum.Format(boiling, Enum.Parse(boiling, s), "d"));

        Colors myColors = Colors.Red | Colors.Blue | Colors.Yellow;
        Console.WriteLine();
        Console.WriteLine("myColors holds a combination of colors. Namely: {0}", myColors);
    }
}

Plataforma universal de Windows
Disponible desde 8
.NET Framework
Disponible desde 1.1
Biblioteca de clases portable
Se admite en: plataformas portátiles de .NET
Silverlight
Disponible desde 2.0
Windows Phone Silverlight
Disponible desde 7.0
Windows Phone
Disponible desde 8.1

This type is thread safe.

Volver al principio
Mostrar: