Enum.IsDefined Метод

Определение

Пространство имен:

System

Сборка:

System.Runtime.dll

Сборка:

mscorlib.dll

Сборка:

netstandard.dll

Перегрузки

IsDefined(Type, Object)	Возвращает логическое значение, указывающее, существует ли заданное целочисленное значение или его имя в виде строки в заданном перечислении.
IsDefined<TEnum>(TEnum)	Возвращает логическое значение, указывающее, существует ли заданное целочисленное значение или его имя в виде строки в заданном перечислении.

IsDefined(Type, Object)

Возвращает логическое значение, указывающее, существует ли заданное целочисленное значение или его имя в виде строки в заданном перечислении.

C#

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

C#

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

Параметры

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 метод с возможными базовыми значениями перечисления, именами строк и составными значениями, которые приводят к настройке нескольких битовых полей.

C#

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

Комментарии

Параметр value может быть любым из следующих значений:

• Любой член типа enumType.

• Переменная, значение которой является элементом перечисления типа enumType.

• Строковое представление имени элемента перечисления. Символы в строке должны иметь тот же регистр, что и имя элемента перечисления.

• Значение базового типа enumType.

Если константы в enumType определении набора битовых полей и value содержат значения, имена или базовые значения нескольких битовых полей, IsDefined метод возвращается false. Другими словами, для перечислений, определяющих набор битовых полей, метод определяет, принадлежит ли одно битовое поле перечислению. Чтобы определить, заданы ли несколько битов в типе перечисления, помеченном атрибутом FlagsAttribute , можно вызвать HasFlag метод.

Примечания для тех, кто вызывает этот метод

Если enumType это перечисление, определенное с помощью атрибута FlagsAttribute , метод возвращает false , если задано несколько битовых полей value , но value не соответствует составному значению перечисления, или если value это объединение строк имен нескольких битовых флагов. В следующем примере перечисление "Домашние животные " определяется атрибутом FlagsAttribute . Метод IsDefined(Type, Object) возвращается false при передаче значения перечисления с двумя битовыми полями (Pets.Dog и Pets.Cat) и при передаче строкового представления этого значения перечисления ("Dog, Cat").

C#

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

Вы можете определить, заданы ли несколько битов, вызвав HasFlag(Enum) метод.

См. также раздел

• GetName(Type, Object)
• GetNames(Type)
• GetValues(Type)
• HasFlag(Enum)

IsDefined<TEnum>(TEnum)

Возвращает логическое значение, указывающее, существует ли заданное целочисленное значение или его имя в виде строки в заданном перечислении.

C#

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

Параметры типа

TEnum

Тип перечисления.

Параметры

value

TEnum

Значение или имя константы в TEnum.

Возвращаемое значение

Boolean

true, если заданное целочисленное значение или его имя в виде строки существует в заданном перечислении; false в противном случае.