Enum.IsDefined Méthode

Référence

Définition

Espace de noms:: System

Assembly:: System.Runtime.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Surcharges

IsDefined(Type, Object)	Retourne un Boolean indiquant si une valeur intégrale donnée, ou son nom sous forme de chaîne, existe dans une énumération spécifiée.
IsDefined<TEnum>(TEnum)	Retourne une valeur booléenne indiquant si une valeur intégrale donnée, ou son nom sous forme de chaîne, existe dans une énumération spécifiée.

IsDefined(Type, Object)

Source:: Enum.cs

Source:: Enum.cs

Source:: Enum.cs

Retourne un Boolean indiquant si une valeur intégrale donnée, ou son nom sous forme de chaîne, existe dans une énumération spécifiée.

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

Paramètres

enumType: Type

Type énumération.

value: Object

Valeur ou nom d’une constante dans enumType.

Retours

Boolean

true si une constante dans enumType a une valeur égale à value ; sinon, false.

Attributs: ComVisibleAttribute

Exceptions

ArgumentNullException

enumType ou value est null.

ArgumentException

enumType n'est pas Enum.

- ou -

Le type de value est une énumération, mais il ne s’agit pas d’une énumération de type enumType.

- ou -

Le type de value n’est pas un type sous-jacent de enumType.

InvalidOperationException

value n’est pas du type SByte, Int16, Int32, Int64, Byte, UInt16, UInt32, UInt64 ni String.

Exemples

L’exemple suivant définit une énumération nommée PetType qui se compose de champs de bits individuels. Il appelle ensuite la méthode avec les IsDefined valeurs d’énumération sous-jacentes possibles, les noms de chaînes et les valeurs composites résultant de la définition de plusieurs champs de bits.

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

Remarques

Le value paramètre peut être l’un des éléments suivants :

Tout membre de type enumType.
Variable dont la valeur est un membre d’énumération de type enumType.
Représentation sous forme de chaîne du nom d’un membre d’énumération. Les caractères de la chaîne doivent avoir la même casse que le nom du membre d’énumération.
Valeur du type sous-jacent de enumType.

Si les constantes dans enumType définissent un ensemble de champs de bits et value contiennent les valeurs, les noms ou les valeurs sous-jacentes de plusieurs champs de bits, la IsDefined méthode retourne false. En d’autres termes, pour les énumérations qui définissent un ensemble de champs de bits, la méthode détermine uniquement si un champ de bits unique appartient à l’énumération. Pour déterminer si plusieurs champs de bits sont définis dans un type d’énumération marqué avec l’attribut FlagsAttribute , vous pouvez appeler la HasFlag méthode .

Notes pour les appelants

Si enumType est une énumération définie à l’aide de l’attribut FlagsAttribute , la méthode retourne false si plusieurs champs de bits dans value sont définis mais value ne correspondent pas à une valeur d’énumération composite, ou si value est une concaténation de chaîne des noms de plusieurs indicateurs de bits. Dans l’exemple suivant, une Pets énumération est définie avec l’attribut FlagsAttribute . La IsDefined(Type, Object) méthode retourne false lorsque vous lui passez une valeur d’énumération qui a deux champs de bits (Pets.Dog et Pets.Cat) définis, et lorsque vous lui transmettez la représentation sous forme de chaîne de cette valeur d’énumération (« 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

Vous pouvez déterminer si plusieurs champs de bits sont définis en appelant la HasFlag(Enum) méthode .

Voir aussi

S’applique à

IsDefined<TEnum>(TEnum)

Source:: Enum.cs

Source:: Enum.cs

Source:: Enum.cs

Retourne une valeur booléenne indiquant si une valeur intégrale donnée, ou son nom sous forme de chaîne, existe dans une énumération spécifiée.

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

Paramètres de type

TEnum

Type de l'énumération.

Paramètres

value: TEnum

Valeur ou nom d’une constante dans TEnum.

Retours

Boolean

true si une valeur intégrale donnée, ou son nom sous forme de chaîne, existe dans une énumération spécifiée ; false dans les autres cas.

S’applique à

Enum.IsDefined Méthode

Définition

Surcharges

IsDefined(Type, Object)

Paramètres

Retours

Exceptions

Exemples

Remarques

Notes pour les appelants

Voir aussi

S’applique à

IsDefined<TEnum>(TEnum)

Paramètres de type

Paramètres

Retours

S’applique à

Commentaires

Ressources supplémentaires