Export (0) Print
Expand All

FlagsAttribute Constructor

Initializes a new instance of the FlagsAttribute class.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

public FlagsAttribute()

The following code example illustrates the use of the FlagsAttribute attribute and shows the effect on the ToString method of using FlagsAttribute on an Enum declaration.

using System;

class Example
{
   // Define an Enum without FlagsAttribute. 
   enum SingleHue : short
   {
      None = 0,
      Black = 1,
      Red = 2,
      Green = 4,
      Blue = 8
   };

   // Define an Enum with FlagsAttribute.
   [FlagsAttribute] 
   enum MultiHue : short
   {
      None = 0,
      Black = 1,
      Red = 2,
      Green = 4,
      Blue = 8
   };

   static void Main( )
   {
      // Display all possible combinations of values.
      Console.WriteLine( 
           "All possible combinations of values without FlagsAttribute:");
      for(int val = 0; val <= 16; val++ )
         Console.WriteLine( "{0,3} - {1:G}", val, (SingleHue)val);

      // Display all combinations of values, and invalid values.
      Console.WriteLine( 
           "\nAll possible combinations of values with FlagsAttribute:");
      for( int val = 0; val <= 16; val++ )
         Console.WriteLine( "{0,3} - {1:G}", val, (MultiHue)val);
   } 
} 
// The example displays the following output: 
//       All possible combinations of values without FlagsAttribute: 
//         0 - None 
//         1 - Black 
//         2 - Red 
//         3 - 3 
//         4 - Green 
//         5 - 5 
//         6 - 6 
//         7 - 7 
//         8 - Blue 
//         9 - 9 
//        10 - 10 
//        11 - 11 
//        12 - 12 
//        13 - 13 
//        14 - 14 
//        15 - 15 
//        16 - 16 
//        
//       All possible combinations of values with FlagsAttribute: 
//         0 - None 
//         1 - Black 
//         2 - Red 
//         3 - Black, Red 
//         4 - Green 
//         5 - Black, Green 
//         6 - Red, Green 
//         7 - Black, Red, Green 
//         8 - Blue 
//         9 - Black, Blue 
//        10 - Red, Blue 
//        11 - Black, Red, Blue 
//        12 - Green, Blue 
//        13 - Black, Green, Blue 
//        14 - Red, Green, Blue 
//        15 - Black, Red, Green, Blue 
//        16 - 16

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft