Enum クラス

定義

列挙体の基底クラスを提供します。

public ref class Enum abstract : ValueType, IComparable, IConvertible, IFormattable
public ref class Enum abstract : ValueType, IComparable, IFormattable
public abstract class Enum : ValueType, IComparable, IConvertible, IFormattable
[System.Serializable]
public abstract class Enum : ValueType, IComparable, IConvertible, IFormattable
[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class Enum : ValueType, IComparable, IConvertible, IFormattable
public abstract class Enum : ValueType, IComparable, IFormattable
type Enum = class
    inherit ValueType
    interface IComparable
    interface IConvertible
    interface IFormattable
[<System.Serializable>]
type Enum = class
    inherit ValueType
    interface IComparable
    interface IFormattable
    interface IConvertible
[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type Enum = class
    inherit ValueType
    interface IComparable
    interface IFormattable
    interface IConvertible
type Enum = class
    inherit ValueType
    interface IComparable
    interface IFormattable
Public MustInherit Class Enum
Inherits ValueType
Implements IComparable, IConvertible, IFormattable
Public MustInherit Class Enum
Inherits ValueType
Implements IComparable, IFormattable
継承
派生
属性
実装

次の例では、列挙体を使用して名前付きの値を表し、別の列挙体を使用して名前付きビットフィールドを表す方法を示します。

using namespace System;
enum class Days
{
   Saturday, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday
};

enum class BoilingPoints
{
   Celsius = 100,
   Fahrenheit = 212
};

[Flags]

enum class Colors
{
   Red = 1,
   Green = 2,
   Blue = 4,
   Yellow = 8
};

int main()
{
   Type^ weekdays = Days::typeid;
   Type^ boiling = BoilingPoints::typeid;
   Console::WriteLine(  "The days of the week, and their corresponding values in the Days Enum are:" );
   Array^ a = Enum::GetNames( weekdays );
   Int32 i = 0;
   do
   {
      Object^ o = a->GetValue( i );
      Console::WriteLine(  "{0,-11}= {1}", o->ToString(), Enum::Format( weekdays, Enum::Parse( weekdays, o->ToString() ),  "d" ) );
   }
   while ( ++i < a->Length );

   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:" );
   i = 0;
   Array^ b = Enum::GetNames( boiling );
   do
   {
      Object^ o = b->GetValue( i );
      Console::WriteLine(  "{0,-11}= {1}", o->ToString(), Enum::Format( boiling, Enum::Parse( boiling, o->ToString() ),  "d" ) );
   }
   while ( ++i < b->Length );

   Array^ c = Enum::GetNames( Colors::typeid );
   Colors myColors = Colors::Red | Colors::Blue | Colors::Yellow;
   Console::WriteLine();
   Console::Write(  "myColors holds a combination of colors. Namely:" );
   for ( i = 0; i < 3; i++ )
      Console::Write(  " {0}", c->GetValue( i ) );
}
using System;

public class EnumTest {
    enum Days { Saturday, Sunday, Monday, Tuesday, Wednesday, Thursday, Friday };
    enum BoilingPoints { Celsius = 100, Fahrenheit = 212 };
    [Flags]
    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);
    }
}
Public Class EnumTest
    Enum Days
        Saturday
        Sunday
        Monday
        Tuesday
        Wednesday
        Thursday
        Friday
    End Enum 
    
    Enum BoilingPoints
        Celsius = 100
        Fahrenheit = 212
    End Enum 
    
    <Flags()> _
    Enum Colors
        Red = 1
        Green = 2
        Blue = 4
        Yellow = 8
    End Enum 

    Public Shared Sub Main()
        Dim weekdays As Type = GetType(Days)
        Dim boiling As Type = GetType(BoilingPoints)

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

        Dim s As String
        For Each s In  [Enum].GetNames(weekdays)
            Console.WriteLine("{0,-11} = {1}", s, [Enum].Format(weekdays, [Enum].Parse(weekdays, s), "d"))
        
        Next s
        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:")

        For Each s In  [Enum].GetNames(boiling)
            Console.WriteLine("{0,-11} = {1}", s, [Enum].Format(boiling, [Enum].Parse(boiling, s), "d"))
        Next s

        Dim myColors As Colors = Colors.Red Or Colors.Blue Or Colors.Yellow
        Console.WriteLine()
        Console.WriteLine("myColors holds a combination of colors. Namely: {0}", myColors)
    End Sub 
End Class

注釈

列挙型は、基になる型が任意の整数型である名前付き定数のセットです。 基になる型が明示的に宣言されていない場合は、Int32が使用されます。 Enumは、 クラス内のすべての列挙体の基本クラス.NET Framework。 列挙型は、C#のenumキーワードとVisual BasicのEnum...End Enum構造で定義します。

Enumは、このクラスのインスタンスを比較し、インスタンスの値を文字列形式に変換し、数値の文字列形式をこのクラスのインスタンスに変換し、指定した列挙体と値のインスタンスを作成するメソッドを提供します。

列挙型をビット フィールドとして扱う方法も可能です。 詳細については、「非排他的メンバーと Flags 属性」セクションおよび「FlagsAttribute」を参照してください。

このトピックの内容:

列挙型の作成
列挙型のインスタンス化
列挙のベスト プラクティス
列挙型を使用した操作の実行
変換の実行
列挙値の解析
列挙値の書式設定
列挙型メンバーの反復
非排他的メンバーと Flags 属性
列挙メソッドの追加

列挙型の作成

プログラミング言語では、通常、名前付き定数とその値のセットで構成される列挙型を宣言するための構文が提供されます。 次の例は、列挙体を定義するために C# および Visual Basic によって使用される構文を示しています。 ArrivalStatus.EarlyArrivalStatus.OnTime、およびArrivalStatus.Lateの3つのメンバーを持つArrivalStatusという名前の列挙体を作成します。 どちらの場合も、列挙体はEnumから明示的に継承されないことに注意してください。継承関係は、コンパイラによって暗黙的に処理されます。

public enum ArrivalStatus { Late=-1, OnTime=0, Early=1 };
Public Enum ArrivalStatus As Integer
   Late = -1
   OnTime = 0
   Early = 1
End Enum

警告

基になる型が非整数または である列挙型を作成する必要があります Char 。 リフレクションを使用してこのような列挙型を作成することができますが、結果として得られる型を使用するメソッド呼び出しは、その他の例外をスローする可能性があります。

列挙型のインスタンス化

他の値型をインスタンス化する場合と同様に、列挙型をインスタンス化するには、変数を宣言し、列挙型の定数の 1 つを割り当てます。 値がArrivalStatus.OnTimeであるArrivalStatusをインスタンス化する例を次に示します。

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)
Public Module Example
   Public Sub Main()
      Dim status As ArrivalStatus = ArrivalStatus.OnTime
      Console.WriteLine("Arrival Status: {0} ({0:D})", status)
   End Sub
End Module
' The example displays the following output:
'        Arrival Status: OnTime (0)

次の方法で列挙値をインスタンス化できます。

  • 特定のプログラミング言語の機能を使用してキャスト (C# の場合) するか、変換する (Visual Basic の場合) ことで、整数値を列挙値に変換します。 次の例では、この方法でArrivalStatus.Early値を持つArrivalStatusオブジェクトを作成します。

    ArrivalStatus status2 = (ArrivalStatus) 1;
    Console.WriteLine("Arrival Status: {0} ({0:D})", status2);
    // The example displays the following output:
    //       Arrival Status: Early (1)
    
    Dim status2 As ArrivalStatus = CType(1, ArrivalStatus)
    Console.WriteLine("Arrival Status: {0} ({0:D})", status2)
    ' The example displays the following output:
    '       Arrival Status: Early (1)
    
  • 暗黙的なパラメーターなしコンストラクターを呼び出す。 次の例に示すように、この場合、列挙インスタンスの基になる値は 0 です。 ただし、これは必ずしも 列挙型の有効な定数の値ではありません。

    ArrivalStatus status1 = new ArrivalStatus();
    Console.WriteLine("Arrival Status: {0} ({0:D})", status1);
    // The example displays the following output:
    //       Arrival Status: OnTime (0)
    
    Dim status1 As New ArrivalStatus()
    Console.WriteLine("Arrival Status: {0} ({0:D})", status1)
    ' The example displays the following output:
    '        Arrival Status: OnTime (0)
    
  • メソッドまたは メソッドを呼び出して、 列挙型の定数の名前を含む Parse TryParse 文字列を解析します。 詳細については、「列挙値の 解析」セクションを参照 してください。

  • メソッドを呼 ToObject び出して整数値を列挙型に変換します。 詳細については、「変換の実行 」セクションを参照 してください。

列挙のベスト プラクティス

列挙型を定義する場合は、次のベスト プラクティスを使用することをお勧めします。

  • 値が 0 の列挙メンバーを定義していない場合は、None列挙定数を作成することを検討してください。 既定では、列挙体に使用されるメモリは、共通言語ランタイムによって 0 に初期化されます。 その結果、値が 0 である定数を定義しなかった場合、列挙体の作成時に無効な値が含まれます。

  • アプリケーションが表す必要がある明らかな既定のケースがある場合は、値が 0 の列挙定数を使用してそれを表すのを検討してください。 既定のケースがない場合は、値が 0 の列挙定数を使用して、他の列挙定数で表されないケースを指定します。

  • 将来使用するために予約されている列挙定数は指定しない。

  • 列挙定数を値として受け取るメソッドまたはプロパティを定義する場合は、値の検証を検討してください。 その理由は、その数値が列挙体で定義されていない場合でも、数値を列挙型にキャストできるからです。

定数がビット フィールドである列挙型のその他のベスト プラクティスについては、「非排他的メンバー」および「 フラグ属性」セクションを参照 してください。

列挙型を使用した操作の実行

列挙型を作成するときに、新しいメソッドを定義することはできません。 ただし、列挙型は、 クラスから静的メソッドとインスタンス メソッドの完全なセットを継承 Enum します。 次のセクションでは、列挙値を操作するときによく使用される他のいくつかのメソッドに加えて、これらのメソッドのほとんどを調査します。

変換の実行

キャスト (C#) または変換 ( Visual Basic) 演算子を使用して、列挙型メンバーとその基になる型の間で変換を行うことができます。 次の例では、キャスト演算子または変換演算子を使用して、整数から列挙値への変換と、列挙値から整数への変換の両方を実行します。

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

int value4 = (int) status3;
Dim value3 As Integer = 2
Dim status3 As ArrivalStatus = CType(value3, ArrivalStatus)

Dim value4 As Integer = CInt(status3)

Enumクラスには、任意の整数型の値を列挙値に変換するToObjectメソッドも含まれています。 次の例では、ToObject(Type, Int32) 、メソッドを使用して、Int32ArrivalStatus値に変換します。 ToObjectObject型の値を返すため、キャスト演算子または変換演算子が、オブジェクトを列挙型にキャストするために必要になる場合があることに注意してください。

int number = -1;
ArrivalStatus arrived = (ArrivalStatus) ArrivalStatus.ToObject(typeof(ArrivalStatus), number);
Dim number As Integer = -1
Dim arrived As ArrivalStatus = CType(ArrivalStatus.ToObject(GetType(ArrivalStatus), number), ArrivalStatus)

整数を列挙値に変換する場合、実際には列挙型のメンバーではない値を割り当てできます。 これを回避するには、変換を実行する前に、IsDefinedメソッドに整数を渡します。 次の例では、このメソッドを使用して、整数値の配列内の要素を値に変換できるかどうかを判断 ArrivalStatus します。

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
Public Enum ArrivalStatus As Integer
   Unknown = -3
   Late = -1
   OnTime = 0
   Early = 1
End Enum

Module Example
   Public Sub Main()
      Dim values() As Integer = { -3, -1, 0, 1, 5, Int32.MaxValue }
      For Each value In values
         Dim status As ArrivalStatus
         If [Enum].IsDefined(GetType(ArrivalStatus), value)
            status = CType(value, ArrivalStatus) 
         Else
            status = ArrivalStatus.Unknown
         End If
         Console.WriteLine("Converted {0:N0} to {1}", value, status)
      Next   
   End Sub
End Module
' 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

Enumクラスには、列挙値から整数型への変換のためのIConvertibleインターフェイスの明示的なインターフェイス実装が用意されていますが、ToInt32などのConvertクラスのメソッドを使用して、これらの変換を実行することをお勧めします。 次の例は、GetUnderlyingTypeメソッドをConvert.ChangeTypeメソッドと共に使用して、列挙値を基になる型に変換する方法を示しています。 この例では、コンパイル時に列挙型の基になる型が既知である必要はなっていない点に注意してください。

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
Dim status As ArrivalStatus = ArrivalStatus.Early
Dim number = Convert.ChangeType(status, [Enum].GetUnderlyingType(GetType(ArrivalStatus)))
Console.WriteLine("Converted {0} to {1}", status, number)
' The example displays the following output:
'       Converted Early to 1

列挙値の解析

ParseメソッドとTryParseメソッドを使用すると、列挙値の文字列形式をその値に変換できます。 文字列形式には、列挙定数の名前または基になる値を指定できます。 文字列を列挙体の基になる型の値に変換できる場合、解析メソッドは特定の列挙型のメンバーではない数値の文字列表現を正常に変換します。 これを回避するには、IsDefinedメソッドを呼び出して、解析メソッドの結果が有効な列挙値であることを確認します。 この例は、この方法を示し、Parse(Type, String)メソッドとEnum.TryParse<TEnum>(String, TEnum)メソッドの両方の呼び出しを示しています。 非ジェネリックの Parse メソッドは、適切な列挙型にキャスト (C# の場合) または変換 (Visual Basic の場合) する必要があるオブジェクトを返すことに注意してください。

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
Dim number As String = "-1"
Dim name As String = "Early"
Dim invalid As String = "32"

Try 
   Dim status1 As ArrivalStatus = CType([Enum].Parse(GetType(ArrivalStatus), number), ArrivalStatus)
   If Not [Enum].IsDefined(GetType(ArrivalStatus), status1) Then status1 = ArrivalStatus.Unknown
   Console.WriteLine("Converted '{0}' to {1}", number, status1)
Catch e As FormatException
   Console.WriteLine("Unable to convert '{0}' to an ArrivalStatus value.", 
                     number)
End Try   
   
Dim status2 As ArrivalStatus
If [Enum].TryParse(Of ArrivalStatus)(name, status2) Then
   If Not [Enum].IsDefined(GetType(ArrivalStatus), status2) Then status2 = ArrivalStatus.Unknown
   Console.WriteLine("Converted '{0}' to {1}", name, status2)
Else
   Console.WriteLine("Unable to convert '{0}' to an ArrivalStatus value.", 
                     number)
End If
' The example displays the following output:
'       Converted '-1' to Late
'       Converted 'Early' to Early

列挙値の書式設定

静的メソッドとインスタンス メソッドのオーバーロードを呼び出すことによって、列挙値を文字列 Format 形式に変換 ToString できます。 書式指定文字列を使用すると、列挙値を文字列として表現する正確な方法を制御できます。 詳細については、「列挙書式指定文字列 」を参照してください。 次の例では、サポートされている各列挙書式指定文字列 ("G" または "g"、"D"、"d"、"X"、"x"、"F"、"f") を使用して、ArrivalStatus列挙体のメンバーを文字列形式に変換します。

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
Dim formats() As String = { "G", "F", "D", "X"}
Dim status As ArrivalStatus = ArrivalStatus.Late
For Each fmt As String In formats
   Console.WriteLine(status.ToString(fmt))
Next
' The example displays the following output:
'       Late
'       Late
'       -1
'       FFFFFFFF

列挙型メンバーの反復

Enum型は、foreach(C#) またはFor Each(Visual Basic) 構造を使用してコレクションのメンバーを反復処理するための、IEnumerableまたはIEnumerable<T>インターフェイスを実装していません。 ただし、次の 2 つの方法のいずれかでメンバーを列挙できます。

  • メソッドを呼び GetNames 出して、列挙型メンバーの名前を含む文字列配列を取得できます。 次に、文字列配列の各要素について、 メソッドを呼び出して、文字列を等価の列挙値 Parse に変換できます。 このアプローチの例を次に示します。

    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)
    
    Dim names() As String = [Enum].GetNames(GetType(ArrivalStatus))
    Console.WriteLine("Members of {0}:", GetType(ArrivalStatus).Name)
    Array.Sort(names)
    For Each name In names
       Dim status As ArrivalStatus = CType([Enum].Parse(GetType(ArrivalStatus), name),
                                     ArrivalStatus)
       Console.WriteLine("   {0} ({0:D})", status)
    Next
    ' The example displays the following output:
    '       Members of ArrivalStatus:
    '          Early (1)
    '          Late (-1)
    '          OnTime (0)
    '          Unknown (-3)
    
  • メソッドを呼び GetValues 出して、 列挙体の基になる値を含む配列を取得できます。 次に、配列の各要素について、 メソッドを呼び出して、整数を等価の列挙値 ToObject に変換できます。 このアプローチの例を次に示します。

    var values = Enum.GetValues(typeof(ArrivalStatus));
    Console.WriteLine("Members of {0}:", typeof(ArrivalStatus).Name);
    foreach (ArrivalStatus status in values) {
       Console.WriteLine("   {0} ({0:D})", status);
    }
    // The example displays the following output:
    //       Members of ArrivalStatus:
    //          OnTime (0)
    //          Early (1)
    //          Unknown (-3)
    //          Late (-1)
    
    Dim values = [Enum].GetValues(GetType(ArrivalStatus))
    Console.WriteLine("Members of {0}:", GetType(ArrivalStatus).Name)
    For Each value In values
       Dim status As ArrivalStatus = CType([Enum].ToObject(GetType(ArrivalStatus), value),
                                           ArrivalStatus)
       Console.WriteLine("   {0} ({0:D})", status)
    Next                                       
    ' The example displays the following output:
    '       Members of ArrivalStatus:
    '          OnTime (0)
    '          Early (1)
    '          Unknown (-3)
    '          Late (-1)
    

非排他的メンバーと Flags 属性

列挙型の一般的な用途の 1 つは、相互に排他的な値のセットを表すことです。 たとえば、ArrivalStatus 、インスタンスは、Early``OnTime、またはLateの値を持つことができます。 インスタンスの値に複数の列挙定数 ArrivalStatus を反映する意味はありません。

ただし別の場合、列挙オブジェクトの値には複数の列挙体メンバーを含めることができ、各メンバーは列挙値のビットフィールドを表します。 属性 FlagsAttribute を使用して、列挙型がビット フィールドで構成されるかどうかを示します。 たとえば、Petsという名前の列挙体を使用して、家族のペットの種類を示すことができます。 次のように定義できます。

[Flags] public enum Pets { None=0, Dog=1, Cat=2, Bird=4, Rodent=8,
                           Reptile=16, Other=32 };
<Flags> Public Enum Pets As Integer
   None = 0
   Dog = 1
   Cat = 2
   Bird = 4
   Rodent = 8
   Reptile = 16
   Other = 32
End Enum

Pets列挙体は、次の例に示すように使用できます。

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

ビット処理列挙型を定義し、 属性を適用する場合は、次のベスト プラクティスを使用する必要 FlagsAttribute があります。

  • 数値に対してビットごとの演算 (AND、OR、EXCLUSIVE OR) を実行する場合にのみ、列挙体のFlagsAttributeカスタム属性を使用します。

  • 1、2、4、8 など、2 の累乗で列挙定数を定義します。 つまり、結合された列挙定数内の個々のフラグは重複しません。

  • よく使用されるフラグの組み合わせに対して列挙定数を作成することを検討してください。 たとえば、列挙定数Read = 1Write = 2を含むファイル I/O 操作に使用する列挙体がある場合、ReadWriteを組み合わせたReadWrite = Read OR Write列挙定数を作成することを検討してください。 また、フラグを結合するために使用されるビットごとの OR 演算は、単純なタスクにとって不必要に高度な概念と見なされる場合があります。

  • フラグの列挙定数として負の数を定義すると、多くのフラグ位置が1に設定されることがあるため、注意してください。これにより、コードの混乱を招く可能性があり、コーディングエラーを助長します。

  • 数値でフラグが設定されているかどうかをテストする便利な方法は、次の例に示すように、HasFlagインスタンスメソッドを呼び出すことです。

    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.
    
    Dim familyPets As Pets = Pets.Dog Or Pets.Cat
    If familyPets.HasFlag(Pets.Dog) Then
       Console.WriteLine("The family has a dog.")
    End If
    ' The example displays the following output:
    '       The family has a dog.
    

    これは、数値とフラグで列挙される定数の間でビットごとの AND 演算を実行することと同じです。この場合、数値のすべてのビットをフラグに対応しないゼロに設定し、その操作の結果がフラグ列挙定数と等しいかどうかをテストします。 この例を次に示します。

    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.
    
    Dim familyPets As Pets = Pets.Dog Or Pets.Cat
    If familyPets And Pets.Dog = Pets.Dog Then
       Console.WriteLine("The family has a dog.")
    End If   
    ' The example displays the following output:
    '       The family has a dog.
    
  • 値が 0 であるフラグ列挙定数の名前としてNoneを使用します。 ビットごとの and 演算では、結果が常に0であるため、None列挙定数を使用してフラグをテストすることはできません。 ただし、数値内のビットが設定されているかどうかを判断するために、数値とNoneに、数値と列挙定数の間でビットごとの比較ではなく論理演算を実行することができます。 この例を次に示します。

    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.
    
    Dim familyPets As Pets = Pets.Dog Or Pets.Cat
    If familyPets = Pets.None Then
       Console.WriteLine("The family has no pets.")
    Else
       Console.WriteLine("The family has pets.")   
    End If
    ' The example displays the following output:
    '       The family has pets.
    
  • 列挙型自体の状態を反映するためだけに列挙値を定義しないでください。 たとえば、列挙型の末尾を示すだけの列挙定数は定義しないでください。 列挙体の最後の値を確認する必要がある場合は、その値を明示的に確認します。 また、範囲内のすべての値が有効な場合は、最初と最後に列挙された定数の範囲チェックを実行できます。

列挙メソッドの追加

列挙型はenum (C#) やEnum (Visual Basic) などの言語構造によって定義されているため、Enumクラスから継承されたメソッド以外の列挙型のカスタムメソッドを定義することはできません。 ただし、拡張メソッドを使用して、特定の列挙型に機能を追加することができます。

次の例では、Grades 列挙型は学生が授業で受け取る成績評価を表わしています。 Passingという名前の拡張機能メソッドがGrades型に追加されていて、この型の各インスタンスが合格点を表しているかどうかを自ら "認識" できるようになっています。 Extensionsクラスには、最小合格評価を定義する静的読み取り/書き込み変数も含まれています。 拡張メソッドの戻り値には、 Passing その変数の現在の値が反映されます。

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.
Imports System.Runtime.CompilerServices

' Define an enumeration to represent student grades.
Public Enum Grades As Integer
   F = 0
   D = 1
   C = 2
   B = 3
   A = 4
End Enum   

' Define an extension method for the Grades enumeration.
Public Module Extensions
  Public minPassing As Grades = Grades.D
 
  <Extension>
  Public Function Passing(grade As Grades) As Boolean
     Return grade >= minPassing
  End Function
End Module

Public Module Example
  Public Sub Main()
      Dim g1 As Grades = Grades.D
      Dim g2 As Grades = Grades.F
      Console.WriteLine("{0} {1} a passing grade.", 
                        g1, If(g1.Passing(), "is", "is not"))
      Console.WriteLine("{0} {1} a passing grade.", 
                        g2, If(g2.Passing(), "is", "is not"))
      Console.WriteLine()
      
      Extensions.minPassing = Grades.C
      Console.WriteLine("Raising the bar!")
      Console.WriteLine()
      Console.WriteLine("{0} {1} a passing grade.", 
                        g1, If(g1.Passing(), "is", "is not"))
      Console.WriteLine("{0} {1} a passing grade.", 
                        g2, If(g2.Passing(), "is", "is not"))
  End Sub
End Module
' 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.

コンストラクター

Enum()

Enum クラスの新しいインスタンスを初期化します。

メソッド

CompareTo(Object)

指定したオブジェクトとこのインスタンスを比較し、これらの相対値を示す値を返します。

Equals(Object)

このインスタンスが指定されたオブジェクトに等しいかどうかを示す値を返します。

Format(Type, Object, String)

指定した形式に従って、指定した列挙型の指定した値をそれと等価の文字列形式に変換します。

GetHashCode()

このインスタンスの値のハッシュ コードを返します。

GetName(Type, Object)

指定した値を持つ指定した列挙体にある定数の名前を取得します。

GetName<TEnum>(TEnum)

指定した値を持つ指定した列挙型に含まれている定数の名前を取得します。

GetNames(Type)

指定した列挙体に含まれている定数の名前の配列を取得します。

GetNames<TEnum>()

指定した列挙型に含まれている定数の名前の配列を取得します。

GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
GetTypeCode()

この列挙メンバーの基になる型の型コードを返します。

GetUnderlyingType(Type)

指定した列挙体の基になる型を返します。

GetValues(Type)

指定した列挙体に含まれている定数の値の配列を取得します。

GetValues<TEnum>()

指定した列挙型に含まれている定数の値の配列を取得します。

HasFlag(Enum)

現在のインスタンスで 1 つ以上のビット フィールドが設定されているかどうかを判断します。

IsDefined(Type, Object)

指定された整数値、またはその名前が文字列として指定した列挙型に存在するかどうかを示すブール値を返します。

IsDefined<TEnum>(TEnum)

指定した整数値、または文字列としてのその名前が、指定した列挙型に存在するかどうかを示すブール値を返します。

MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
Parse(Type, ReadOnlySpan<Char>)

1 つ以上の列挙定数の名前または数値の文字表現のスパンを、同等の列挙オブジェクトに変換します。

Parse(Type, ReadOnlySpan<Char>, Boolean)

1 つ以上の列挙定数の名前または数値の文字表現のスパンを、同等の列挙オブジェクトに変換します。 演算で大文字と小文字を区別しないかどうかをパラメーターで指定します。

Parse(Type, String)

文字列形式での 1 つ以上の列挙定数の名前または数値を、等価の列挙オブジェクトに変換します。

Parse(Type, String, Boolean)

文字列形式での 1 つ以上の列挙定数の名前または数値を、等価の列挙オブジェクトに変換します。 演算で大文字と小文字を区別しないかどうかをパラメーターで指定します。

Parse<TEnum>(ReadOnlySpan<Char>)

で指定された 1 つ以上の列挙定数の名前または数値の文字表現のスパンを、同等の列挙オブジェクト TEnum に変換します。

Parse<TEnum>(ReadOnlySpan<Char>, Boolean)

で指定された 1 つ以上の列挙定数の名前または数値の文字表現のスパンを、同等の列挙オブジェクト TEnum に変換します。 演算で大文字と小文字を区別しないかどうかをパラメーターで指定します。

Parse<TEnum>(String)

TEnum で指定されている 1 つ以上の列挙定数の名前または数値の文字列表現を、等価の列挙オブジェクトに変換します。

Parse<TEnum>(String, Boolean)

TEnum で指定されている 1 つ以上の列挙定数の名前または数値の文字列表現を、等価の列挙オブジェクトに変換します。 演算で大文字と小文字を区別しないかどうかをパラメーターで指定します。

ToObject(Type, Byte)

指定した 8 ビット符号なし整数を列挙メンバーに変換します。

ToObject(Type, Int16)

指定した 16 ビット符号付き整数を列挙メンバーに変換します。

ToObject(Type, Int32)

指定した 32 ビット符号付き整数を列挙メンバーに変換します。

ToObject(Type, Int64)

指定した 64 ビット符号付き整数を列挙メンバーに変換します。

ToObject(Type, Object)

整数値を持つ指定したオブジェクトを列挙メンバーに変換します。

ToObject(Type, SByte)

指定した 8 ビット符号付き整数値を列挙メンバーに変換します。

ToObject(Type, UInt16)

指定した 16 ビット符号なし整数値を列挙メンバーに変換します。

ToObject(Type, UInt32)

指定した 32 ビット符号なし整数値を列挙メンバーに変換します。

ToObject(Type, UInt64)

指定した 64 ビット符号なし整数値を列挙メンバーに変換します。

ToString()

このインスタンスの値を、それと等価の文字列形式に変換します。

ToString(IFormatProvider)
互換性のために残されています。
互換性のために残されています。

このメソッドのオーバーロードは現在使用しません。代わりに ToString() を使用します。

ToString(String)

指定した書式を使用して、このインスタンスの値をそれと等価な文字列形式に変換します。

ToString(String, IFormatProvider)
互換性のために残されています。
互換性のために残されています。

このメソッドのオーバーロードは現在使用しません。代わりに ToString(String) を使用します。

TryParse(Type, ReadOnlySpan<Char>, Boolean, Object)

1 つ以上の列挙定数の名前または数値の文字表現のスパンを、同等の列挙オブジェクトに変換します。 演算で大文字と小文字を区別しないかどうかをパラメーターで指定します。

TryParse(Type, ReadOnlySpan<Char>, Object)

1 つ以上の列挙定数の名前または数値の文字表現のスパンを、同等の列挙オブジェクトに変換します。

TryParse(Type, String, Boolean, Object)

文字列形式での 1 つ以上の列挙定数の名前または数値を、等価の列挙オブジェクトに変換します。

TryParse(Type, String, Object)

文字列形式での 1 つ以上の列挙定数の名前または数値を、等価の列挙オブジェクトに変換します。

TryParse<TEnum>(ReadOnlySpan<Char>, Boolean, TEnum)

文字列形式での 1 つ以上の列挙定数の名前または数値を、等価の列挙オブジェクトに変換します。 演算で大文字と小文字を区別するかどうかをパラメーターで指定します。 戻り値は、変換が成功したかどうかを示します。

TryParse<TEnum>(ReadOnlySpan<Char>, TEnum)

文字列形式での 1 つ以上の列挙定数の名前または数値を、等価の列挙オブジェクトに変換します。

TryParse<TEnum>(String, Boolean, TEnum)

文字列形式での 1 つ以上の列挙定数の名前または数値を、等価の列挙オブジェクトに変換します。 演算で大文字と小文字を区別するかどうかをパラメーターで指定します。 戻り値は、変換が成功したかどうかを示します。

TryParse<TEnum>(String, TEnum)

文字列形式での 1 つ以上の列挙定数の名前または数値を、等価の列挙オブジェクトに変換します。 戻り値は、変換が成功したかどうかを示します。

明示的なインターフェイスの実装

IConvertible.GetTypeCode()

この Enum インスタンスの型コードを返します。

IConvertible.ToBoolean(IFormatProvider)

基になる型に基づいて、現在の値をブール値に変換します。

IConvertible.ToByte(IFormatProvider)

基になる型に基づいて、現在の値を 8 ビット符号なし整数に変換します。

IConvertible.ToChar(IFormatProvider)

基になる型に基づいて、現在の値を Unicode 文字に変換します。

IConvertible.ToDateTime(IFormatProvider)

基になる型に基づいて、現在の値を DateTime に変換します。

IConvertible.ToDecimal(IFormatProvider)

基になる型に基づいて、現在の値を Decimal に変換します。

IConvertible.ToDouble(IFormatProvider)

基になる型に基づいて、現在の値を倍精度浮動小数点数に変換します。

IConvertible.ToInt16(IFormatProvider)

基になる型に基づいて、現在の値を 16 ビット符号付き整数に変換します。

IConvertible.ToInt32(IFormatProvider)

基になる型に基づいて、現在の値を 32 ビット符号付き整数に変換します。

IConvertible.ToInt64(IFormatProvider)

基になる型に基づいて、現在の値を 64 ビット符号付き整数に変換します。

IConvertible.ToSByte(IFormatProvider)

基になる型に基づいて、現在の値を 8 ビット符号付き整数に変換します。

IConvertible.ToSingle(IFormatProvider)

基になる型に基づいて、現在の値を単精度浮動小数点数に変換します。

IConvertible.ToString(IFormatProvider)
互換性のために残されています。

このメソッドのオーバーロードは現在使用しません。代わりに ToString() を使用します。

IConvertible.ToType(Type, IFormatProvider)

基になる型に基づいて、現在の値を指定した型に変換します。

IConvertible.ToUInt16(IFormatProvider)

基になる型に基づいて、現在の値を 16 ビット符号なし整数に変換します。

IConvertible.ToUInt32(IFormatProvider)

基になる型に基づいて、現在の値を 32 ビット符号なし整数に変換します。

IConvertible.ToUInt64(IFormatProvider)

基になる型に基づいて、現在の値を 64 ビット符号なし整数に変換します。

IFormattable.ToString(String, IFormatProvider)
互換性のために残されています。

このメソッドのオーバーロードは現在使用しません。代わりに ToString(String) を使用します。

適用対象

スレッド セーフ

この型はスレッド セーフです。

こちらもご覧ください