Enum.IsDefined Methode

Definition

Überlädt

IsDefined(Type, Object)

Gibt einen booleschen Wert zurück, der angibt, ob ein angegebener Integralwert (oder dessen Name als Zeichenfolge) in einer angegebenen Enumeration vorhanden ist.Returns a Boolean telling whether a given integral value, or its name as a string, exists in a specified enumeration.

IsDefined<TEnum>(TEnum)

Gibt einen booleschen Wert zurück, der angibt, ob ein angegebener Integralwert (oder dessen Name als Zeichenfolge) in einer angegebenen Enumeration vorhanden ist.Returns a boolean telling whether a given integral value, or its name as a string, exists in a specified enumeration.

IsDefined(Type, Object)

Gibt einen booleschen Wert zurück, der angibt, ob ein angegebener Integralwert (oder dessen Name als Zeichenfolge) in einer angegebenen Enumeration vorhanden ist.Returns a Boolean telling whether a given integral value, or its name as a string, exists in a specified enumeration.

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

Parameter

enumType
Type

Ein Enumerationstyp.An enumeration type.

value
Object

Der Wert oder Name einer Konstanten von enumType.The value or name of a constant in enumType.

Gibt zurück

Boolean

true, wenn eine Konstante in enumType den Wert value hat, andernfalls false.true if a constant in enumType has a value equal to value; otherwise, false.

Attribute

Ausnahmen

enumType oder value ist null.enumType or value is null.

enumType ist keine Enum.enumType is not an Enum.

- oder --or- Der Typ von value ist eine Enumeration, aber keine Enumeration vom Typ enumType.The type of value is an enumeration, but it is not an enumeration of type enumType.

- oder --or- Der Typ von value ist kein zugrunde liegender Typ von enumType.The type of value is not an underlying type of enumType.

value ist nicht vom Typ SByte, Int16, Int32, Int64, Byte, UInt16, UInt32, UInt64 oder String.value is not type SByte, Int16, Int32, Int64, Byte, UInt16, UInt32, or UInt64, or String.

Beispiele

Im folgenden Beispiel wird eine Enumeration mit dem Namen definiert PetType , die aus einzelnen Bitfeldern besteht.The following example defines an enumeration named PetType that consists of individual bit fields. Anschließend wird die- IsDefined Methode mit möglichen zugrunde liegenden Enumerationswerten, Zeichen folgen Namen und zusammengesetzten Werten aufgerufen, die aus dem Festlegen mehrerer Bitfelder resultieren.It then calls the IsDefined method with possible underlying enumeration values, string names, and composite values that result from setting multiple bit fields.

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
<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

Hinweise

Der- value Parameter kann eine der folgenden sein:The value parameter can be any of the following:

  • Ein beliebiger Member des Typs enumType .Any member of type enumType.

  • Eine Variable, deren Wert ein Enumerationsmember vom Typ ist enumType .A variable whose value is an enumeration member of type enumType.

  • Die Zeichen folgen Darstellung des Namens eines Enumerationsmembers.The string representation of the name of an enumeration member. Die Zeichen in der Zeichenfolge müssen dieselbe Groß-/Kleinschreibung aufweisen wie der Name des Enumerationsmembers.The characters in the string must have the same case as the enumeration member name.

  • Ein Wert des zugrunde liegenden Typs von enumType .A value of the underlying type of enumType.

Wenn die Konstanten in enumType einen Satz von Bitfeldern definieren und value die Werte, Namen oder zugrunde liegenden Werte mehrerer Bitfelder enthalten, gibt die IsDefined Methode zurück false .If the constants in enumType define a set of bit fields and value contains the values, names, or underlying values of multiple bit fields, the IsDefined method returns false. Anders ausgedrückt: für Enumerationen, die einen Satz von Bitfeldern definieren, bestimmt die-Methode nur, ob ein einzelnes Bitfeld zur-Enumeration gehört.In other words, for enumerations that define a set of bit fields, the method determines only whether a single bit field belongs to the enumeration. Um zu ermitteln, ob mehrere Bitfelder in einem Enumerationstyp festgelegt sind, der mit dem-Attribut markiert ist FlagsAttribute , können Sie die-Methode aufzurufen HasFlag .To determine whether multiple bit fields are set in an enumeration type that is tagged with the FlagsAttribute attribute, you can call the HasFlag method.

Hinweise für Aufrufer

Wenn enumType eine Enumeration ist, die mithilfe des- FlagsAttribute Attributs definiert wird, gibt die Methode zurück, false Wenn mehrere Bitfelder in value festgelegt sind value , aber nicht einem zusammengesetzten Enumerationswert entsprechen, oder wenn value eine Zeichen folgen Verkettung der Namen mehrerer Bitflags ist.If enumType is an enumeration that is defined by using the FlagsAttribute attribute, the method returns false if multiple bit fields in value are set but value does not correspond to a composite enumeration value, or if value is a string concatenation of the names of multiple bit flags. Im folgenden Beispiel wird eine Pets -Enumeration mit dem- FlagsAttribute Attribut definiert.In the following example, a Pets enumeration is defined with the FlagsAttribute attribute. Die IsDefined(Type, Object) -Methode gibt zurück false , wenn Sie Ihr einen Enumerationswert übergeben, der zwei Bitfelder (pets. Dog und pets.cat) aufweist, und wenn Sie die Zeichen folgen Darstellung dieses Enumerationswerts ("Dog, Cat") übergeben.The IsDefined(Type, Object) method returns false when you pass it an enumeration value that has two bit fields (Pets.Dog and Pets.Cat) set, and when you pass it the string representation of that enumeration value ("Dog, Cat").

::: Code language = "CSharp" Source = "~/Samples/Snippets/CSharp/VS_Snippets_CLR_System/System. Enum. IsDefined/CS/isdefined2. cs "Interactive =" try-dotnet "ID =" Snippet2 ":::::: Code language =" vb "Source =" ~/Samples/Snippets/VisualBasic/VS_Snippets_CLR_System/System. "Umum. IsDefined/VB/isdefined2. vb" ID = "Snippet2"::::::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_CLR_System/system.Enum.IsDefined/cs/isdefined2.cs" interactive="try-dotnet" id="Snippet2"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Enum.IsDefined/vb/isdefined2.vb" id="Snippet2":::

Sie können bestimmen, ob mehrere Bitfelder durch Aufrufen der-Methode festgelegt werden HasFlag(Enum) .You can determine whether multiple bit fields are set by calling the HasFlag(Enum) method.

Siehe auch

Gilt für:

IsDefined<TEnum>(TEnum)

Gibt einen booleschen Wert zurück, der angibt, ob ein angegebener Integralwert (oder dessen Name als Zeichenfolge) in einer angegebenen Enumeration vorhanden ist.Returns a boolean telling whether a given integral value, or its name as a string, exists in a specified enumeration.

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

Typparameter

TEnum

Der Typ der Enumeration.The type of the enumeration.

Parameter

value
TEnum

Der Wert oder Name einer Konstanten in TEnum.The value or name of a constant in TEnum.

Gibt zurück

Boolean

true, wenn ein angegebener Integralwert (oder dessen Name als Zeichenfolge) in einer angegebenen Enumeration vorhanden ist, andernfalls false.true if a given integral value, or its name as a string, exists in a specified enumeration; false otherwise.

Gilt für: