Enum.IsDefined メソッド

定義

名前空間:: System

アセンブリ:: mscorlib.dll, System.Runtime.dll

アセンブリ:: netstandard.dll, System.Runtime.dll

アセンブリ:: System.Runtime.dll

アセンブリ:: mscorlib.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

オーバーロード

名前	説明
IsDefined(Type, Object)	指定した整数値またはその名前を文字列として指定した列挙体に存在するかどうかを示すブール値を返します。
IsDefined<TEnum>(TEnum)	指定した整数値またはその名前を文字列として指定した列挙体に存在するかどうかを示すブール値を返します。

IsDefined(Type, Object)

ソース:: Enum.cs

ソース:: Enum.cs

ソース:: Enum.cs

ソース:: Enum.cs

ソース:: Enum.cs

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

public:
 static bool IsDefined(Type ^ enumType, System::Object ^ value);

public static bool IsDefined(Type enumType, object value);

[System.Runtime.InteropServices.ComVisible(true)]
public static bool IsDefined(Type enumType, object value);

static member IsDefined : Type * obj -> bool

[<System.Runtime.InteropServices.ComVisible(true)>]
static member IsDefined : Type * obj -> bool

Public Shared Function IsDefined (enumType As Type, value As Object) As Boolean

パラメーター

enumType: Type

列挙型。

value: Object

enumType内の定数の値または名前。

返品

Boolean

true enumTypeの定数に value と等しい値がある場合は false。それ以外の場合は。

属性: ComVisibleAttribute

例外

ArgumentNullException

enumType または value が null。

ArgumentException

enumType は Enumではありません。

-又は-

valueの型は列挙型ですが、enumType型の列挙型ではありません。

-又は-

valueの型は、enumTypeの基になる型ではありません。

InvalidOperationException

value は、型 SByte、 Int16、 Int32、 Int64、 Byte、 UInt16、 UInt32、または UInt64、または Stringではありません。

例

次の例では、個々のビットフィールドで構成される PetType という名前の列挙体を定義します。次に、複数のビットフィールドを設定した結果、基になる列挙値、文字列名、複合値を使用して、 IsDefined メソッドを呼び出します。

using System;

[Flags] public enum PetType
{
   None = 0, Dog = 1, Cat = 2, Rodent = 4, Bird = 8, Reptile = 16, Other = 32
};

public class Example
{
   public static void Main()
   {
      object value;

      // Call IsDefined with underlying integral value of member.
      value = 1;
      Console.WriteLine("{0}: {1}", value, Enum.IsDefined(typeof(PetType), value));
      // Call IsDefined with invalid underlying integral value.
      value = 64;
      Console.WriteLine("{0}: {1}", value, Enum.IsDefined(typeof(PetType), value));
      // Call IsDefined with string containing member name.
      value = "Rodent";
      Console.WriteLine("{0}: {1}", value, Enum.IsDefined(typeof(PetType), value));
      // Call IsDefined with a variable of type PetType.
      value = PetType.Dog;
      Console.WriteLine("{0}: {1}", value, Enum.IsDefined(typeof(PetType), value));
      value = PetType.Dog | PetType.Cat;
      Console.WriteLine("{0}: {1}", value, Enum.IsDefined(typeof(PetType), value));
      // Call IsDefined with uppercase member name.
      value = "None";
      Console.WriteLine("{0}: {1}", value, Enum.IsDefined(typeof(PetType), value));
      value = "NONE";
      Console.WriteLine("{0}: {1}", value, Enum.IsDefined(typeof(PetType), value));
      // Call IsDefined with combined value
      value = PetType.Dog | PetType.Bird;
      Console.WriteLine("{0:D}: {1}", value, Enum.IsDefined(typeof(PetType), value));
      value = value.ToString();
      Console.WriteLine("{0:D}: {1}", value, Enum.IsDefined(typeof(PetType), value));
   }
}
// The example displays the following output:
//       1: True
//       64: False
//       Rodent: True
//       Dog: True
//       Dog, Cat: False
//       None: True
//       NONE: False
//       9: False
//       Dog, Bird: False

open System

[<Flags>]
type PetType =
    | None = 0
    | Dog = 1
    | Cat = 2
    | Rodent = 4
    | Bird = 8
    | Reptile = 16
    | Other = 32

[<EntryPoint>]
let main _ =
    // Call IsDefined with underlying integral value of member.
    let value = 1
    printfn $"{value}: {Enum.IsDefined(typeof<PetType>, value)}"
    // Call IsDefined with invalid underlying integral value.
    let value = 64
    printfn $"{value}: {Enum.IsDefined(typeof<PetType>, value)}"
    // Call IsDefined with string containing member name.
    let value = "Rodent"
    printfn $"{value}: {Enum.IsDefined(typeof<PetType>, value)}"
    // Call IsDefined with a variable of type PetType.
    let value = PetType.Dog
    printfn $"{value}: {Enum.IsDefined(typeof<PetType>, value)}"
    let value = PetType.Dog ||| PetType.Cat
    printfn $"{value}: {Enum.IsDefined(typeof<PetType>, value)}"
    // Call IsDefined with uppercase member name.
    let value = "None"
    printfn $"{value}: {Enum.IsDefined(typeof<PetType>, value)}"
    let value = "NONE"
    printfn $"{value}: {Enum.IsDefined(typeof<PetType>, value)}"
    // Call IsDefined with combined value
    let value = PetType.Dog ||| PetType.Bird
    printfn $"{value:D}: {Enum.IsDefined(typeof<PetType>, value)}"
    let value = value.ToString()
    printfn $"{value:D}: {Enum.IsDefined(typeof<PetType>, value)}"
    0
// The example displays the following output:
//       1: True
//       64: False
//       Rodent: True
//       Dog: True
//       Dog, Cat: False
//       None: True
//       NONE: False
//       9: False
//       Dog, Bird: False

<Flags> Public Enum PetType As Integer
   None = 0
   Dog = 1
   Cat = 2
   Rodent = 4
   Bird = 8
   Reptile = 16
   Other = 32
End Enum

Module Example
   Public Sub Main()
      Dim value As Object
      
      ' Call IsDefined with underlying integral value of member.
      value = 1
      Console.WriteLine("{0}: {1}", value, [Enum].IsDefined(GetType(PetType), value))
      ' Call IsDefined with invalid underlying integral value.
      value = 64
      Console.WriteLine("{0}: {1}", value, [Enum].IsDefined(GetType(PetType), value))
      ' Call IsDefined with string containing member name.
      value = "Rodent"
      Console.WriteLine("{0}: {1}", value, [Enum].IsDefined(GetType(PetType), value))
      ' Call IsDefined with a variable of type PetType.
      value = PetType.Dog
      Console.WriteLine("{0}: {1}", value, [Enum].IsDefined(GetType(PetType), value))
      value = PetType.Dog Or PetType.Cat
      Console.WriteLine("{0}: {1}", value, [Enum].IsDefined(GetType(PetType), value))
      ' Call IsDefined with uppercase member name.      
      value = "None"
      Console.WriteLine("{0}: {1}", value, [Enum].IsDefined(GetType(PetType), value))
      value = "NONE"
      Console.WriteLine("{0}: {1}", value, [Enum].IsDefined(GetType(PetType), value))
      ' Call IsDefined with combined value
      value = PetType.Dog Or PetType.Bird
      Console.WriteLine("{0:D}: {1}", value, [Enum].IsDefined(GetType(PetType), value))
      value = value.ToString()
      Console.WriteLine("{0:D}: {1}", value, [Enum].IsDefined(GetType(PetType), value))
   End Sub
End Module
' The example displays the following output:
'       1: True
'       64: False 
'       Rodent: True
'       Dog: True
'       Dog, Cat: False
'       None: True
'       NONE: False
'       9: False
'       Dog, Bird: False

注釈

value パラメーターには、次のいずれかを指定できます。

enumType型のメンバー。
値が enumType型の列挙メンバーである変数。
列挙メンバーの名前の文字列形式。文字列内の文字は、列挙メンバー名と同じ大文字と小文字を区別する必要があります。
enumTypeの基になる型の値。

enumTypeの定数でビットフィールドのセットを定義し、valueに複数のビットフィールドの値、名前、または基になる値が含まれている場合、IsDefined メソッドはfalseを返します。つまり、ビットフィールドのセットを定義する列挙体の場合、メソッドは、1 つのビットフィールドが列挙型に属しているかどうかを判断します。 FlagsAttribute属性でタグ付けされた列挙型に複数のビットフィールドが設定されているかどうかを確認するには、HasFlag メソッドを呼び出します。

注意 (呼び出し元)

enumTypeがFlagsAttribute属性を使用して定義された列挙体である場合、メソッドは、false内の複数のビットフィールドが設定されているが、valueが複合列挙値に対応していない場合、またはvalueが複数のビットフラグの名前の文字列連結である場合に、valueを返します。次の例では、 Pets 列挙体が FlagsAttribute 属性で定義されています。 IsDefined(Type, Object) メソッドは、2 つのビットフィールド (falseとPets.Dog) が設定された列挙値を渡すと、Pets.Catを返し、その列挙値の文字列表現 ("Dog, Cat") を渡すときに返します。

using System;

[Flags] public enum Pets {
      None = 0, Dog = 1, Cat = 2, Bird = 4,
      Rodent = 8, Other = 16 };

public class Example
{
   public static void Main()
   {
      Pets value = Pets.Dog | Pets.Cat;
      Console.WriteLine("{0:D} Exists: {1}",
                        value, Pets.IsDefined(typeof(Pets), value));
      string name = value.ToString();
      Console.WriteLine("{0} Exists: {1}",
                        name, Pets.IsDefined(typeof(Pets), name));
   }
}
// The example displays the following output:
//       3 Exists: False
//       Dog, Cat Exists: False

open System

[<Flags>]
type Pets =
    | None = 0
    | Dog = 1
    | Cat = 2
    | Bird = 4
    | Rodent = 8
    | Other = 16

let value = Pets.Dog ||| Pets.Cat
printfn $"{value:D} Exists: {Pets.IsDefined(typeof<Pets>, value)}"
let name = string value
printfn $"{name} Exists: {Pets.IsDefined(typeof<Pets>, name)}"
// The example displays the following output:
//       3 Exists: False
//       Dog, Cat Exists: False

<Flags> Public Enum Pets As Integer
   None = 0
   Dog = 1
   Cat = 2
   Bird = 4
   Rodent = 8
   Other = 16
End Enum

Module Example
   Public Sub Main()
      Dim value As Pets = Pets.Dog Or Pets.Cat
      Console.WriteLine("{0:D} Exists: {1}", 
                        value, Pets.IsDefined(GetType(Pets), value))
      Dim name As String = value.ToString()
      Console.WriteLine("{0} Exists: {1}", 
                        name, Pets.IsDefined(GetType(Pets), name))
   End Sub
End Module
' The example displays the following output:
'       3 Exists: False
'       Dog, Cat Exists: False

HasFlag(Enum) メソッドを呼び出すことによって、複数のビットフィールドが設定されているかどうかを確認できます。

こちらもご覧ください

適用対象

IsDefined<TEnum>(TEnum)

ソース:: Enum.cs

ソース:: Enum.cs

ソース:: Enum.cs

ソース:: Enum.cs

ソース:: Enum.cs

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

public:
generic <typename TEnum>
 where TEnum : value class static bool IsDefined(TEnum value);

public static bool IsDefined<TEnum>(TEnum value) where TEnum : struct;

static member IsDefined : 'Enum -> bool (requires 'Enum : struct)

Public Shared Function IsDefined(Of TEnum As Structure) (value As TEnum) As Boolean

型パラメーター

TEnum

列挙体の型。

パラメーター

value: TEnum

TEnum内の定数の値または名前。

返品

Boolean

true 指定された整数値またはその名前が文字列として存在する場合は、指定した列挙体に存在します。それ以外の場合 false 。

適用対象

フィードバック

このページはお役に立ちましたか?