¿Qué significa el atributo de enumeración [Flags] en C #?

De vez en cuando veo una enumeración como la siguiente:

[Flags]
public enum Options 
{
    None    = 0,
    Option1 = 1,
    Option2 = 2,
    Option3 = 4,
    Option4 = 8
}

No entiendo qué hace exactamente el [Flags]atributo.

¿Alguien tiene una buena explicación o ejemplo que podrían publicar?

El [Flags]atributo debe usarse siempre que el enumerable represente una colección de valores posibles, en lugar de un solo valor. Tales colecciones a menudo se usan con operadores bit a bit, por ejemplo:

var allowedColors = MyColor.Red | MyColor.Green | MyColor.Blue;

Tenga en cuenta que el [Flags]atributo no habilita esto por sí mismo; todo lo que hace es permitir una buena representación por el .ToString()método:

enum Suits { Spades = 1, Clubs = 2, Diamonds = 4, Hearts = 8 }
[Flags] enum SuitsFlags { Spades = 1, Clubs = 2, Diamonds = 4, Hearts = 8 }

...

var str1 = (Suits.Spades | Suits.Diamonds).ToString();
           // "5"
var str2 = (SuitsFlags.Spades | SuitsFlags.Diamonds).ToString();
           // "Spades, Diamonds"

También es importante tener en cuenta que [Flags] no hace automáticamente que los valores de enumeración sean potencias de dos. Si omite los valores numéricos, la enumeración no funcionará como cabría esperar en las operaciones bit a bit, ya que de forma predeterminada los valores comienzan con 0 y se incrementan.

Declaración incorrecta

[Flags]
public enum MyColors
{
    Yellow,  // 0
    Green,   // 1
    Red,     // 2
    Blue     // 3
}

Los valores, si se declaran de esta manera, serán Amarillo = 0, Verde = 1, Rojo = 2, Azul = 3. Esto lo hará inútil como banderas.

Aquí hay un ejemplo de una declaración correcta:

[Flags]
public enum MyColors
{
    Yellow = 1,
    Green = 2,
    Red = 4,
    Blue = 8
}

Para recuperar los valores distintos en su propiedad, uno puede hacer esto:

if (myProperties.AllowedColors.HasFlag(MyColor.Yellow))
{
    // Yellow is allowed...
}

o antes de .NET 4:

if((myProperties.AllowedColors & MyColor.Yellow) == MyColor.Yellow)
{
    // Yellow is allowed...
}

if((myProperties.AllowedColors & MyColor.Green) == MyColor.Green)
{
    // Green is allowed...
}    

Debajo de las sábanas

Esto funciona porque usaste poderes de dos en tu enumeración. Debajo de las cubiertas, sus valores de enumeración se ven así en binarios y ceros:

 Yellow: 00000001
 Green:  00000010
 Red:    00000100
 Blue:   00001000

Del mismo modo, después de haber configurado su propiedad AllowColors en Rojo, Verde y Azul utilizando el |operador OR binario a nivel de bit , AllowColors se ve así:

myProperties.AllowedColors: 00001110

Entonces, cuando recupera el valor, en realidad está realizando bit a bit Y &en los valores:

myProperties.AllowedColors: 00001110
             MyColor.Green: 00000010
             -----------------------
                            00000010 // Hey, this is the same as MyColor.Green!

El valor Ninguno = 0

Y con respecto al uso de 0en su enumeración, citando de MSDN:

[Flags]
public enum MyColors
{
    None = 0,
    ....
}

Use None como el nombre de la constante enumerada de bandera cuyo valor es cero. No puede usar la constante enumerada None en una operación AND a nivel de bit para probar un indicador porque el resultado siempre es cero. Sin embargo, puede realizar una comparación lógica, no bit a bit, entre el valor numérico y la constante Ninguno enumerado para determinar si se establecen bits en el valor numérico.

Puede encontrar más información sobre el atributo flags y su uso en msdn y diseñar banderas en msdn

También puedes hacer esto

[Flags]
public enum MyEnum
{
    None   = 0,
    First  = 1 << 0,
    Second = 1 << 1,
    Third  = 1 << 2,
    Fourth = 1 << 3
}

Encuentro el cambio de bits más fácil que escribir 4,8,16,32 y así sucesivamente. No tiene impacto en su código porque todo se hace en tiempo de compilación

Combinando las respuestas https://stackoverflow.com/a/8462/1037948 (declaración mediante bit-shifting) y https://stackoverflow.com/a/9117/1037948 (usando combinaciones en la declaración) puede cambiar bit en lugar de los valores anteriores que usar números. No necesariamente lo recomiendo, sino solo señalar que puedes.

Más bien que:

[Flags]
public enum Options : byte
{
    None    = 0,
    One     = 1 << 0,   // 1
    Two     = 1 << 1,   // 2
    Three   = 1 << 2,   // 4
    Four    = 1 << 3,   // 8

    // combinations
    OneAndTwo = One | Two,
    OneTwoAndThree = One | Two | Three,
}

Puedes declarar

[Flags]
public enum Options : byte
{
    None    = 0,
    One     = 1 << 0,       // 1
    // now that value 1 is available, start shifting from there
    Two     = One << 1,     // 2
    Three   = Two << 1,     // 4
    Four    = Three << 1,   // 8

    // same combinations
    OneAndTwo = One | Two,
    OneTwoAndThree = One | Two | Three,
}

Confirmando con LinqPad:

foreach(var e in Enum.GetValues(typeof(Options))) {
    string.Format("{0} = {1}", e.ToString(), (byte)e).Dump();
}

Resultados en:

None = 0
One = 1
Two = 2
OneAndTwo = 3
Three = 4
OneTwoAndThree = 7
Four = 8

Consulte lo siguiente para ver un ejemplo que muestra la declaración y el uso potencial:

namespace Flags
{
    class Program
    {
        [Flags]
        public enum MyFlags : short
        {
            Foo = 0x1,
            Bar = 0x2,
            Baz = 0x4
        }

        static void Main(string[] args)
        {
            MyFlags fooBar = MyFlags.Foo | MyFlags.Bar;

            if ((fooBar & MyFlags.Foo) == MyFlags.Foo)
            {
                Console.WriteLine("Item has Foo flag set");
            }
        }
    }
}

En extensión a la respuesta aceptada, en C # 7 los indicadores de enumeración se pueden escribir utilizando literales binarios:

[Flags]
public enum MyColors
{
    None   = 0b0000,
    Yellow = 0b0001,
    Green  = 0b0010,
    Red    = 0b0100,
    Blue   = 0b1000
}

Creo que esta representación deja en claro cómo funcionan las banderas debajo de las cubiertas .

Me preguntó recientemente sobre algo similar.

Si usa banderas, puede agregar un método de extensión a las enumeraciones para facilitar la verificación de las banderas contenidas (consulte la publicación para más detalles)

Esto te permite hacer:

[Flags]
public enum PossibleOptions : byte
{
    None = 0,
    OptionOne = 1,
    OptionTwo = 2,
    OptionThree = 4,
    OptionFour = 8,

    //combinations can be in the enum too
    OptionOneAndTwo = OptionOne | OptionTwo,
    OptionOneTwoAndThree = OptionOne | OptionTwo | OptionThree,
    ...
}

Entonces puedes hacer:

PossibleOptions opt = PossibleOptions.OptionOneTwoAndThree 

if( opt.IsSet( PossibleOptions.OptionOne ) ) {
    //optionOne is one of those set
}

Encuentro esto más fácil de leer que la mayoría de las formas de verificar las banderas incluidas.

@Nidonocu

Para agregar otro indicador a un conjunto de valores existente, use el operador de asignación OR.

Mode = Mode.Read;
//Add Mode.Write
Mode |= Mode.Write;
Assert.True(((Mode & Mode.Write) == Mode.Write)
  && ((Mode & Mode.Read) == Mode.Read)));

Cuando trabajo con banderas, a menudo declaro Ninguno y Todos los elementos adicionales. Estos son útiles para verificar si todas las banderas están configuradas o no.

[Flags] 
enum SuitsFlags { 

    None =     0,

    Spades =   1 << 0, 
    Clubs =    1 << 1, 
    Diamonds = 1 << 2, 
    Hearts =   1 << 3,

    All =      ~(~0 << 4)

}

Uso:

Spades | Clubs | Diamonds | Hearts == All  // true
Spades & Clubs == None  // true

 
Actualización 2019-10:

Desde C # 7.0 puede usar literales binarios, que probablemente sean más intuitivos de leer:

[Flags] 
enum SuitsFlags { 

    None =     0b0000,

    Spades =   0b0001, 
    Clubs =    0b0010, 
    Diamonds = 0b0100, 
    Hearts =   0b1000,

    All =      0b1111

}

Para agregar Mode.Write:

Mode = Mode | Mode.Write;

Hay algo demasiado detallado para mí acerca de la if ((x & y) == y)...construcción, especialmente si xAND yson conjuntos compuestos de banderas y solo desea saber si hay alguna superposición.

En este caso, todo lo que realmente necesita saber es si hay un valor distinto de cero [1] después de haber enmascarado .

[1] Ver el comentario de Jaime. Si estuviéramos auténticamente enmascarando bits , solo tendríamos que verificar que el resultado fuera positivo. Pero dado que enums puede ser negativo, incluso, extrañamente, cuando se combina con el [Flags] atributo , es defensivo codificar en != 0lugar de hacerlo > 0.

Partiendo de la configuración de @ andnil ...

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace BitFlagPlay
{
    class Program
    {
        [Flags]
        public enum MyColor
        {
            Yellow = 0x01,
            Green = 0x02,
            Red = 0x04,
            Blue = 0x08
        }

        static void Main(string[] args)
        {
            var myColor = MyColor.Yellow | MyColor.Blue;
            var acceptableColors = MyColor.Yellow | MyColor.Red;

            Console.WriteLine((myColor & MyColor.Blue) != 0);     // True
            Console.WriteLine((myColor & MyColor.Red) != 0);      // False                
            Console.WriteLine((myColor & acceptableColors) != 0); // True
            // ... though only Yellow is shared.

            Console.WriteLine((myColor & MyColor.Green) != 0);    // Wait a minute... ;^D

            Console.Read();
        }
    }
}

Las banderas le permiten usar bitmasking dentro de su enumeración. Esto le permite combinar valores de enumeración, mientras conserva cuáles se especifican.

[Flags]
public enum DashboardItemPresentationProperties : long
{
    None = 0,
    HideCollapse = 1,
    HideDelete = 2,
    HideEdit = 4,
    HideOpenInNewWindow = 8,
    HideResetSource = 16,
    HideMenu = 32
}

Disculpas si alguien ya notó este escenario. Un ejemplo perfecto de banderas que podemos ver en la reflexión. Sí Banderas vinculantes ENUM. https://docs.microsoft.com/en-us/dotnet/api/system.reflection.bindingflags?view=netframework-4.8

[System.Flags]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public enum BindingFlags

Uso

             // BindingFlags.InvokeMethod
            // Call a static method.
            Type t = typeof (TestClass);

            Console.WriteLine();
            Console.WriteLine("Invoking a static method.");
            Console.WriteLine("-------------------------");
            t.InvokeMember ("SayHello", BindingFlags.InvokeMethod | BindingFlags.Public | 
                BindingFlags.Static, null, null, new object [] {});