我不时会看到如下枚举:

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

我不明白[Flags]属性到底做什么。

任何人都有一个很好的解释或例子可以发布?


当前回答

请参见以下示例,以了解声明和潜在用法:

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");
            }
        }
    }
}

其他回答

@Nidonucu公司

要向现有值集添加另一个标志,请使用OR赋值运算符。

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

标志允许您在枚举中使用位掩码。这允许您组合枚举值,同时保留指定的值。

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

请参见以下示例,以了解声明和潜在用法:

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");
            }
        }
    }
}

作为可接受答案的扩展,在C#7中,枚举标志可以使用二进制文本编写:

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

我认为这一表述清楚地表明了旗帜在幕后的运作方式。

每当可枚举值表示可能值的集合而不是单个值时,都应使用[Flags]属性。此类集合通常与按位运算符一起使用,例如:

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

请注意,[Flags]属性本身并不启用此功能,它所做的只是允许.ToString()方法进行良好的表示:

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"

还需要注意的是,[Flags]不会自动将枚举值设为2的幂。如果忽略数值,枚举将无法按位操作中的预期工作,因为默认情况下,值以0和递增开头。

声明不正确:

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

如果以这种方式声明,值将为黄色=0,绿色=1,红色=2,蓝色=3。这将使其作为标志无效。

以下是正确声明的示例:

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

要检索属性中的不同值,可以执行以下操作:

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

或.NET 4之前的版本:

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

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

在盖子下面

这是因为在枚举中使用了2的幂。在封面下,枚举值以二进制1和0表示如下:

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

类似地,在使用二进制位OR |运算符将属性AllowedColors设置为红色、绿色和蓝色后,AllowedColors如下所示:

myProperties.AllowedColors: 00001110

因此,当您检索值时,实际上正在对值执行逐位AND运算(&O):

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

None=0值

关于在枚举中使用0,引用MSDN:

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

使用None作为值为零的标志枚举常量的名称。不能在按位AND操作中使用None枚举常量来测试标志,因为结果始终为零。但是,可以在数值和None枚举常量之间执行逻辑(而不是按位)比较,以确定是否设置了数值中的任何位。

您可以在msdn中找到有关flags属性及其用法的更多信息,并在msdn上设计flags