O que o Atributo Enum [Flags] significa em C #?

De tempos em tempos, vejo um enum como o seguinte:

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

Não entendo exatamente o que o [Flags]atributo faz.

Alguém tem uma boa explicação ou exemplo que poderia postar?

O [Flags]atributo deve ser usado sempre que o enumerável representar uma coleção de valores possíveis, em vez de um único valor. Essas coleções são frequentemente usadas com operadores bit a bit, por exemplo:

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

Observe que o [Flags]atributo não permite isso por si só - tudo o que faz é permitir uma boa representação pelo .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"

Também é importante notar que [Flags] não fazer automaticamente os valores ENUM potências de dois. Se você omitir os valores numéricos, a enumeração não funcionará como seria de esperar em operações bit a bit, porque, por padrão, os valores começam com 0 e incrementam.

Declaração incorreta:

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

Os valores, se declarados dessa maneira, serão Amarelo = 0, Verde = 1, Vermelho = 2, Azul = 3. Isso o tornará inútil como sinalizadores.

Aqui está um exemplo de uma declaração correta:

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

Para recuperar os valores distintos em sua propriedade, é possível fazer o seguinte:

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

ou anterior ao .NET 4:

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

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

Debaixo das cobertas

Isso funciona porque você usou poderes de dois em sua enumeração. Nos bastidores, seus valores de enumeração são assim em zeros e binários:

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

Da mesma forma, depois de definir sua propriedade AllowedColors como Vermelho, Verde e Azul usando o |operador binário OR bit a bit , AllowedColors fica assim:

myProperties.AllowedColors: 00001110

Portanto, quando você recupera o valor, está realmente executando AND bit a bit &nos valores:

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

O valor None = 0

E sobre o uso de 0na sua enumeração, citando o MSDN:

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

Use None como o nome da constante enumerada do sinalizador cujo valor é zero. Você não pode usar a constante enumerada None em uma operação AND bit a bit para testar um sinalizador porque o resultado é sempre zero. No entanto, você pode executar uma comparação lógica, não um bit a bit, entre o valor numérico e a constante enumerada None para determinar se algum bit no valor numérico está definido.

Você pode encontrar mais informações sobre o atributo flags e seu uso no msdn e sobre o design de flags no msdn

Você também pode fazer isso

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

Acho a mudança de bits mais fácil do que digitar 4,8,16,32 e assim por diante. Não tem impacto no seu código, porque tudo é feito em tempo de compilação

Combinando as respostas https://stackoverflow.com/a/8462/1037948 (declaração via deslocamento de bits) e https://stackoverflow.com/a/9117/1037948 (usando combinações na declaração), você pode alterar os valores anteriores em vez de do que usar números. Não necessariamente recomendando, mas apenas apontando que você pode.

Ao invés de:

[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,
}

Você pode 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 com LinqPad:

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

Resulta em:

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

Consulte o seguinte para um exemplo que mostra a declaração e o 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");
            }
        }
    }
}

Em extensão à resposta aceita, em C # 7 os sinalizadores de enum podem ser escritos usando literais binários:

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

Eu acho que essa representação deixa claro como as bandeiras funcionam embaixo das cobertas .

Eu perguntei recentemente sobre algo semelhante.

Se você usar sinalizadores, poderá adicionar um método de extensão às enumerações para facilitar a verificação dos sinalizadores contidos (consulte a publicação para obter detalhes)

Isso permite que você faça:

[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,
    ...
}

Então você pode fazer:

PossibleOptions opt = PossibleOptions.OptionOneTwoAndThree 

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

Acho isso mais fácil de ler do que a maioria das maneiras de verificar os sinalizadores incluídos.

@Nidonocu

Para adicionar outro sinalizador a um conjunto de valores existente, use o operador de atribuição OR.

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

Ao trabalhar com sinalizadores, muitas vezes declaro itens adicionais Nenhum e Todos. Isso é útil para verificar se todos os sinalizadores estão definidos ou se nenhum sinalizador está definido.

[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

 
Atualização 2019-10:

Desde o C # 7.0, você pode usar literais binários, provavelmente mais intuitivos de ler:

[Flags] 
enum SuitsFlags { 

    None =     0b0000,

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

    All =      0b1111

}

Para adicionar Mode.Write:

Mode = Mode | Mode.Write;

Há algo excessivamente detalhado para mim sobre a if ((x & y) == y)...construção, especialmente se xAND ysão conjuntos compostos de sinalizadores e você só quer saber se há alguma sobreposição.

Nesse caso, tudo o que você realmente precisa saber é se existe um valor diferente de zero [1] após a mascaragem .

[1] Veja o comentário de Jaime. Se estivéssemos autenticamente usando máscaras de bits , precisaríamos apenas verificar se o resultado era positivo. Mas como enums pode ser negativo, mesmo que estranhamente, quando combinado com o [Flags] atributo , é defensivo codificar em != 0vez de > 0.

Criando fora da configuração do @ 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();
        }
    }
}

Os sinalizadores permitem que você use máscaras de bits na sua enumeração. Isso permite combinar valores de enumeração, mantendo quais são especificados.

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

Desculpas se alguém já percebeu esse cenário. Um exemplo perfeito de bandeiras que podemos ver na reflexão. Sim Sinalizadores de ligação 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 [] {});