Enum.Parse Метод

Определение

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

System

Сборка:

System.Runtime.dll

Преобразует строковое представление имени или числового значения одной или нескольких перечислимых констант в эквивалентный перечислимый объект.

Перегрузки

Parse(Type, ReadOnlySpan<Char>)	Преобразует диапазон символов, представление имени или числового значения одной или нескольких перечисляемых констант в эквивалентный перечислимый объект.
Parse(Type, String)	Преобразует строковое представление имени или числового значения одной или нескольких перечислимых констант в эквивалентный перечислимый объект.
Parse(Type, ReadOnlySpan<Char>, Boolean)	Преобразует диапазон символов, представление имени или числового значения одной или нескольких перечисляемых констант в эквивалентный перечислимый объект. Параметр указывает, учитывается ли в операции регистр.
Parse(Type, String, Boolean)	Преобразует строковое представление имени или числового значения одной или нескольких перечислимых констант в эквивалентный перечислимый объект. Параметр указывает, учитывается ли в операции регистр.
Parse<TEnum>(String, Boolean)	Преобразует строковое представление имени или числового значения одной или нескольких перечислимых констант, указанных в параметре TEnum, в эквивалентный перечислимый объект. Параметр указывает, учитывается ли в операции регистр.
Parse<TEnum>(ReadOnlySpan<Char>, Boolean)	Преобразует диапазон символов, представление имени или числового значения одной или нескольких перечисляемых констант, заданных параметром TEnum , в эквивалентный перечислимый объект. Параметр указывает, учитывается ли в операции регистр.
Parse<TEnum>(ReadOnlySpan<Char>)	Преобразует диапазон символов, представление имени или числового значения одной или нескольких перечисляемых констант, заданных параметром TEnum , в эквивалентный перечислимый объект.
Parse<TEnum>(String)	Преобразует строковое представление имени или числового значения одной или нескольких перечислимых констант, указанных в параметре TEnum, в эквивалентный перечислимый объект.

Parse(Type, ReadOnlySpan<Char>)

Исходный код:

Enum.cs

Преобразует диапазон символов, представление имени или числового значения одной или нескольких перечисляемых констант в эквивалентный перечислимый объект.

public:
 static System::Object ^ Parse(Type ^ enumType, ReadOnlySpan<char> value);

public static object Parse (Type enumType, ReadOnlySpan<char> value);

static member Parse : Type * ReadOnlySpan<char> -> obj

Public Shared Function Parse (enumType As Type, value As ReadOnlySpan(Of Char)) As Object

Параметры

enumType

Type

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

value

ReadOnlySpan<Char>

Диапазон, содержащий имя или значение для преобразования.

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

Object

Объект типа enumType, значение которого представлено параметром value.

Исключения

ArgumentNullException

enumType имеет значение null.

ArgumentException

Значение параметра enumType не является объектом Enum.

ArgumentException

value является пустой строкой или содержит только пробелы.

ArgumentException

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

OverflowException

value находится вне диапазона базового типа enumType.

InvalidOperationException

.NET 8 и более поздних версий: enumType является типом перечисления с логическим поддержкой.

Parse(Type, String)

Исходный код:

Enum.cs

Преобразует строковое представление имени или числового значения одной или нескольких перечислимых констант в эквивалентный перечислимый объект.

public:
 static System::Object ^ Parse(Type ^ enumType, System::String ^ value);

public static object Parse (Type enumType, string value);

static member Parse : Type * string -> obj

Public Shared Function Parse (enumType As Type, value As String) As Object

Параметры

enumType

Type

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

value

String

Строка, содержащая имя или значение для преобразования.

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

Object

Объект типа enumType, значение которого представлено параметром value.

Исключения

ArgumentNullException

Параметр enumType или value имеет значение null.

ArgumentException

Значение параметра enumType не является объектом Enum.

-или-

value является пустой строкой или содержит только пробелы.

-или-

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

OverflowException

value находится вне диапазона базового типа enumType.

InvalidOperationException

.NET 8 и более поздних версий: enumType является типом перечисления с логическим поддержкой.

Примеры

В следующем примере метод используется Parse(Type, String) для анализа массива строк, созданных путем вызова GetNames метода . Он также использует Parse(Type, String) метод для анализа значения перечисления, состоящего из битового поля.

using namespace System;

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

int main()
{
   Console::WriteLine(  "The entries of the Colors enumeration are:" );
   Array^ a = Enum::GetNames( Colors::typeid );
   Int32 i = 0;
   while ( i < a->Length )
   {
      Object^ o = a->GetValue( i );
      Console::WriteLine( o->ToString() );
      i++;
   }

   Console::WriteLine();
   Object^ orange = Enum::Parse( Colors::typeid,  "Red, Yellow" );
   Console::WriteLine("The orange value has the combined entries of {0}", orange );
}

/*
This code example produces the following results:

The entries of the Colors Enum are:
Red
Green
Blue
Yellow

The orange value has the combined entries of Red, Yellow

*/

using System;

public class ParseTest
{
    [Flags]
    enum Colors { Red = 1, Green = 2, Blue = 4, Yellow = 8 };

    public static void Main()
    {
        Console.WriteLine("The entries of the Colors enumeration are:");
        foreach (string colorName in Enum.GetNames(typeof(Colors)))
        {
            Console.WriteLine("{0} = {1:D}", colorName,
                                         Enum.Parse(typeof(Colors), colorName));
        }
        Console.WriteLine();

        Colors orange = (Colors) Enum.Parse(typeof(Colors), "Red, Yellow");
        Console.WriteLine("The orange value {0:D} has the combined entries of {0}",
                           orange);
    }
}

/*
This code example produces the following results:

The entries of the Colors Enum are:
Red = 1
Green = 2
Blue = 4
Yellow = 8

The orange value 9 has the combined entries of Red, Yellow

*/

open System

[<Flags>]
type Colors =
    | Red = 1
    | Green = 2
    | Blue = 4
    | Yellow = 8

printfn "The entries of the Colors enumeration are:"
for colorName in Enum.GetNames typeof<Colors> do
    printfn $"{colorName} = {Enum.Parse(typeof<Colors>, colorName):D}"
printfn ""

let orange = Enum.Parse(typeof<Colors>, "Red, Yellow") :?> Colors
printfn $"The orange value {orange:D} has the combined entries of {orange}"

// This code example produces the following results:
//     The entries of the Colors Enum are:
//     Red = 1
//     Green = 2
//     Blue = 4
//     Yellow = 8
//    
//     The orange value 9 has the combined entries of Red, Yellow

Public Class ParseTest

    <Flags()> _
    Enum Colors
        Red = 1
        Green = 2
        Blue = 4
        Yellow = 8
    End Enum

    Public Shared Sub Main()
        Console.WriteLine("The entries of the Colors enumeration are:")
        Dim colorName As String
        For Each colorName In [Enum].GetNames(GetType(Colors))
            Console.WriteLine("{0} = {1:D}", colorName, [Enum].Parse(GetType(Colors), colorName))
        Next
        Console.WriteLine()

        Dim orange As Colors = CType([Enum].Parse(GetType(Colors), "Red, Yellow"), Colors)
        Console.WriteLine("The orange value {0:D} has the combined entries of {0}", orange)
    End Sub
End Class

'This example displays the following output:
'
'The entries of the Colors Enum are:
'Red = 1
'Green = 2
'Blue = 4
'Yellow = 8
'
'The myOrange value 9 has the combined entries of Red, Yellow
'

Комментарии

Параметр value содержит строковое представление базового значения элемента перечисления или именованной константы или список именованных констант, разделенных запятыми (,). Один или несколько пустых пробелов могут предшествовать или следовать за каждым значением, именем или запятыми в value. Если value является списком, возвращаемое значение представляет собой значение указанных имен в сочетании с побитовой OR операцией.

Если value является именем, которое не соответствует именованной константе enumType, метод вызывает исключение ArgumentException. Если value является строковым представлением целого числа, которое не представляет базовое enumType значение перечисления, метод возвращает элемент перечисления, базовое значение которого преобразуется value в целочисленный тип. Если такое поведение нежелательно, вызовите IsDefined метод , чтобы убедиться, что определенное строковое представление целого числа фактически является членом enumType. В следующем примере определяется Colors перечисление, вызывается Parse(Type, String) метод для преобразования строк в соответствующие значения перечисления и вызывается IsDefined метод , чтобы гарантировать, что определенные целочисленные значения являются базовыми значениями в перечислении Colors .

using System;

[Flags] enum Colors { None=0, Red = 1, Green = 2, Blue = 4 };

public class Example
{
   public static void Main()
   {
      string[] colorStrings = { "0", "2", "8", "blue", "Blue", "Yellow", "Red, Green" };
      foreach (string colorString in colorStrings)
      {
         try {
            Colors colorValue = (Colors) Enum.Parse(typeof(Colors), colorString);
            if (Enum.IsDefined(typeof(Colors), colorValue) | colorValue.ToString().Contains(","))
               Console.WriteLine("Converted '{0}' to {1}.", colorString, colorValue.ToString());
            else
               Console.WriteLine("{0} is not an underlying value of the Colors enumeration.", colorString);
         }
         catch (ArgumentException) {
            Console.WriteLine("'{0}' is not a member of the Colors enumeration.", colorString);
         }
      }
   }
}
// The example displays the following output:
//       Converted '0' to None.
//       Converted '2' to Green.
//       8 is not an underlying value of the Colors enumeration.
//       'blue' is not a member of the Colors enumeration.
//       Converted 'Blue' to Blue.
//       'Yellow' is not a member of the Colors enumeration.
//       Converted 'Red, Green' to Red, Green.

open System

[<Flags>]
type Colors =
    | None = 0
    | Red = 1
    | Green = 2
    | Blue = 4

let colorStrings = [ "0"; "2"; "8"; "blue"; "Blue"; "Yellow"; "Red, Green" ]
for colorString in colorStrings do
    try
        let colorValue = Enum.Parse(typeof<Colors>, colorString) :?> Colors
        if Enum.IsDefined(typeof<Colors>, colorValue) || (string colorValue).Contains "," then
            printfn $"Converted '{colorString}' to {colorValue}."
        else
            printfn $"{colorString} is not an underlying value of the Colors enumeration."
    with :? ArgumentException ->
        printfn $"'{colorString}' is not a member of the Colors enumeration."
// The example displays the following output:
//       Converted '0' to None.
//       Converted '2' to Green.
//       8 is not an underlying value of the Colors enumeration.
//       'blue' is not a member of the Colors enumeration.
//       Converted 'Blue' to Blue.
//       'Yellow' is not a member of the Colors enumeration.
//       Converted 'Red, Green' to Red, Green.

<Flags> Enum Colors As Integer
   None = 0
   Red = 1
   Green = 2
   Blue = 4
End Enum

Module Example
   Public Sub Main()
      Dim colorStrings() As String = {"0", "2", "8", "blue", "Blue", "Yellow", "Red, Green"}
      For Each colorString As String In colorStrings
         Try
            Dim colorValue As Colors = CType([Enum].Parse(GetType(Colors), colorString), Colors)        
            If [Enum].IsDefined(GetType(Colors), colorValue) Or colorValue.ToString().Contains(",") Then 
               Console.WriteLine("Converted '{0}' to {1}.", colorString, colorValue.ToString())
            Else
               Console.WriteLine("{0} is not an underlying value of the Colors enumeration.", colorString)            
            End If                    
         Catch e As ArgumentException
            Console.WriteLine("'{0}' is not a member of the Colors enumeration.", colorString)
         End Try
      Next
   End Sub
End Module
' The example displays the following output:
'       Converted '0' to None.
'       Converted '2' to Green.
'       8 is not an underlying value of the Colors enumeration.
'       'blue' is not a member of the Colors enumeration.
'       Converted 'Blue' to Blue.
'       'Yellow' is not a member of the Colors enumeration.
'       Converted 'Red, Green' to Red, Green.

Эта операция учитывает регистр.

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

• IsDefined(Type, Object)

Parse(Type, ReadOnlySpan<Char>, Boolean)

Исходный код:

Enum.cs

Преобразует диапазон символов, представление имени или числового значения одной или нескольких перечисляемых констант в эквивалентный перечислимый объект. Параметр указывает, учитывается ли в операции регистр.

public:
 static System::Object ^ Parse(Type ^ enumType, ReadOnlySpan<char> value, bool ignoreCase);

public static object Parse (Type enumType, ReadOnlySpan<char> value, bool ignoreCase);

static member Parse : Type * ReadOnlySpan<char> * bool -> obj

Public Shared Function Parse (enumType As Type, value As ReadOnlySpan(Of Char), ignoreCase As Boolean) As Object

Параметры

enumType

Type

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

value

ReadOnlySpan<Char>

Диапазон, содержащий имя или значение для преобразования.

ignoreCase

Boolean

Значение true предписывает игнорировать регистр. В противном случае — значение false.

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

Object

Объект типа enumType, значение которого представлено параметром value.

Исключения

ArgumentNullException

enumType имеет значение null.

ArgumentException

Значение параметра enumType не является объектом Enum.

ArgumentException

value является пустой строкой или содержит только пробелы.

ArgumentException

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

OverflowException

value находится за пределами диапазона базового типа enumType

InvalidOperationException

.NET 8 и более поздних версий: enumType является типом перечисления с логическим поддержкой.

Parse(Type, String, Boolean)

Исходный код:

Enum.cs

Преобразует строковое представление имени или числового значения одной или нескольких перечислимых констант в эквивалентный перечислимый объект. Параметр указывает, учитывается ли в операции регистр.

public:
 static System::Object ^ Parse(Type ^ enumType, System::String ^ value, bool ignoreCase);

public static object Parse (Type enumType, string value, bool ignoreCase);

static member Parse : Type * string * bool -> obj

Public Shared Function Parse (enumType As Type, value As String, ignoreCase As Boolean) As Object

Параметры

enumType

Type

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

value

String

Строка, содержащая имя или значение для преобразования.

ignoreCase

Boolean

Значение true предписывает игнорировать регистр. В противном случае — значение false.

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

Object

Объект типа enumType, значение которого представлено параметром value.

Исключения

ArgumentNullException

Параметр enumType или value имеет значение null.

ArgumentException

Значение параметра enumType не является объектом Enum.

-или-

value является пустой строкой ("") или содержит только пробелы.

-или-

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

OverflowException

value находится вне диапазона базового типа enumType.

InvalidOperationException

.NET 8 и более поздних версий: enumType является типом перечисления с логическим поддержкой.

Примеры

В следующем примере метод используется Parse(Type, String, Boolean) для анализа массива строк, созданных путем вызова GetNames метода . Он также использует Parse(Type, String) метод для анализа значения перечисления, состоящего из битового поля.

using System;

[Flags] enum Colors { None=0, Red = 1, Green = 2, Blue = 4 };

public class Example
{
   public static void Main()
   {
      string[] colorStrings = { "0", "2", "8", "blue", "Blue", "Yellow", "Red, Green" };
      foreach (string colorString in colorStrings)
      {
         try {
            Colors colorValue = (Colors) Enum.Parse(typeof(Colors), colorString, true);
            if (Enum.IsDefined(typeof(Colors), colorValue) | colorValue.ToString().Contains(","))
               Console.WriteLine("Converted '{0}' to {1}.", colorString, colorValue.ToString());
            else
               Console.WriteLine("{0} is not an underlying value of the Colors enumeration.", colorString);
         }
         catch (ArgumentException) {
            Console.WriteLine("{0} is not a member of the Colors enumeration.", colorString);
         }
      }
   }
}
// The example displays the following output:
//       Converted '0' to None.
//       Converted '2' to Green.
//       8 is not an underlying value of the Colors enumeration.
//       Converted 'blue' to Blue.
//       Converted 'Blue' to Blue.
//       Yellow is not a member of the Colors enumeration.
//       Converted 'Red, Green' to Red, Green.

open System

[<Flags>]
type Colors =
    | None = 0
    | Red = 1
    | Green = 2
    | Blue = 4

let colorStrings = [ "0"; "2"; "8"; "blue"; "Blue"; "Yellow"; "Red, Green" ]
for colorString in colorStrings do
    try
        let colorValue = Enum.Parse(typeof<Colors>, colorString, true) :?> Colors
        if Enum.IsDefined(typeof<Colors>, colorValue) || (string colorValue).Contains "," then
            printfn $"Converted '{colorString}' to {colorValue}."
        else
            printfn $"{colorString} is not an underlying value of the Colors enumeration."
    with :? ArgumentException ->
        printfn $"{colorString} is not a member of the Colors enumeration."

// The example displays the following output:
//       Converted '0' to None.
//       Converted '2' to Green.
//       8 is not an underlying value of the Colors enumeration.
//       Converted 'blue' to Blue.
//       Converted 'Blue' to Blue.
//       Yellow is not a member of the Colors enumeration.
//       Converted 'Red, Green' to Red, Green.

<Flags> Enum Colors As Integer
   None = 0
   Red = 1
   Green = 2
   Blue = 4
End Enum

Module Example
   Public Sub Main()
      Dim colorStrings() As String = {"0", "2", "8", "blue", "Blue", "Yellow", "Red, Green"}
      For Each colorString As String In colorStrings
         Try
            Dim colorValue As Colors = CType([Enum].Parse(GetType(Colors), colorString, True), Colors)        
            If [Enum].IsDefined(GetType(Colors), colorValue) Or colorValue.ToString().Contains(",") Then 
               Console.WriteLine("Converted '{0}' to {1}.", colorString, colorValue.ToString())
            Else
               Console.WriteLine("{0} is not an underlying value of the Colors enumeration.", colorString)            
            End If                    
         Catch e As ArgumentException
            Console.WriteLine("{0} is not a member of the Colors enumeration.", colorString)
         End Try
      Next
   End Sub
End Module
' The example displays the following output:
'       Converted '0' to None.
'       Converted '2' to Green.
'       8 is not an underlying value of the Colors enumeration.
'       Converted 'blue' to Blue.
'       Converted 'Blue' to Blue.
'       Yellow is not a member of the Colors enumeration.
'       Converted 'Red, Green' to Red, Green.

Комментарии

Параметр value содержит строковое представление базового значения элемента перечисления или именованной константы или список именованных констант, разделенных запятыми (,). Один или несколько пустых пробелов могут предшествовать или следовать за каждым значением, именем или запятыми в value. Если value является списком, возвращаемое значение представляет собой значение указанных имен в сочетании с побитовой OR операцией.

Если value является именем, которое не соответствует именованной константе enumType, метод вызывает исключение ArgumentException. Если value является строковым представлением целого числа, которое не представляет базовое enumType значение перечисления, метод возвращает элемент перечисления, базовое значение которого преобразуется value в целочисленный тип. Если такое поведение нежелательно, вызовите IsDefined метод , чтобы убедиться, что определенное строковое представление целого числа фактически является членом enumType. В следующем примере определяется Colors перечисление, вызывается Parse(Type, String, Boolean) метод для преобразования строк в соответствующие значения перечисления и вызывается IsDefined метод , чтобы гарантировать, что определенные целочисленные значения являются базовыми значениями в перечислении Colors .

Параметр ignoreCase указывает, учитывается ли регистр в этой операции.

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

• IsDefined(Type, Object)

Parse<TEnum>(String, Boolean)

Исходный код:

Enum.cs

Преобразует строковое представление имени или числового значения одной или нескольких перечислимых констант, указанных в параметре TEnum, в эквивалентный перечислимый объект. Параметр указывает, учитывается ли в операции регистр.

public:
generic <typename TEnum>
 where TEnum : value class static TEnum Parse(System::String ^ value, bool ignoreCase);

public static TEnum Parse<TEnum> (string value, bool ignoreCase) where TEnum : struct;

static member Parse : string * bool -> 'Enum (requires 'Enum : struct)

Public Shared Function Parse(Of TEnum As Structure) (value As String, ignoreCase As Boolean) As TEnum

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

TEnum

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

Параметры

value

String

Строка, содержащая имя или значение для преобразования.

ignoreCase

Boolean

Значение true предписывает игнорировать регистр. В противном случае — значение false.

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

TEnum

Объект типа TEnum, значение которого представлено параметром value.

Исключения

ArgumentException

Параметр TEnum не является типом Enum.

ArgumentNullException

value имеет значение null.

ArgumentException

value не содержит сведения о перечислении.

InvalidOperationException

.NET 8 и более поздних версий: TEnum является типом перечисления с логическим поддержкой.

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

Исходный код:

Enum.cs

Преобразует диапазон символьного представления имени или числового значения одной или нескольких перечисляемых констант, заданных параметром TEnum , в эквивалентный перечислимый объект. Параметр указывает, учитывается ли в операции регистр.

public:
generic <typename TEnum>
 where TEnum : value class static TEnum Parse(ReadOnlySpan<char> value, bool ignoreCase);

public static TEnum Parse<TEnum> (ReadOnlySpan<char> value, bool ignoreCase) where TEnum : struct;

static member Parse : ReadOnlySpan<char> * bool -> 'Enum (requires 'Enum : struct)

Public Shared Function Parse(Of TEnum As Structure) (value As ReadOnlySpan(Of Char), ignoreCase As Boolean) As TEnum

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

TEnum

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

Параметры

value

ReadOnlySpan<Char>

Диапазон, содержащий имя или значение для преобразования.

ignoreCase

Boolean

Значение true предписывает игнорировать регистр. В противном случае — значение false.

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

TEnum

TEnum Объект типа TEnum , значение которого представлено value.

Исключения

ArgumentException

Параметр TEnum не является типом Enum.

ArgumentException

value не содержит сведения о перечислении.

InvalidOperationException

.NET 8 и более поздних версий: TEnum является логическим типом перечисления.

Parse<TEnum>(ReadOnlySpan<Char>)

Исходный код:

Enum.cs

Преобразует диапазон символьного представления имени или числового значения одной или нескольких перечисляемых констант, заданных параметром TEnum , в эквивалентный перечислимый объект.

public:
generic <typename TEnum>
 where TEnum : value class static TEnum Parse(ReadOnlySpan<char> value);

public static TEnum Parse<TEnum> (ReadOnlySpan<char> value) where TEnum : struct;

static member Parse : ReadOnlySpan<char> -> 'Enum (requires 'Enum : struct)

Public Shared Function Parse(Of TEnum As Structure) (value As ReadOnlySpan(Of Char)) As TEnum

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

TEnum

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

Параметры

value

ReadOnlySpan<Char>

Диапазон, содержащий имя или значение для преобразования.

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

TEnum

TEnum Объект типа TEnum , значение которого представлено value.

Исключения

ArgumentException

Параметр TEnum не является типом Enum.

ArgumentException

value не содержит сведения о перечислении.

InvalidOperationException

.NET 8 и более поздних версий: TEnum является логическим типом перечисления.

Parse<TEnum>(String)

Исходный код:

Enum.cs

Преобразует строковое представление имени или числового значения одной или нескольких перечислимых констант, указанных в параметре TEnum, в эквивалентный перечислимый объект.

public:
generic <typename TEnum>
 where TEnum : value class static TEnum Parse(System::String ^ value);

public static TEnum Parse<TEnum> (string value) where TEnum : struct;

static member Parse : string -> 'Enum (requires 'Enum : struct)

Public Shared Function Parse(Of TEnum As Structure) (value As String) As TEnum

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

TEnum

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

Параметры

value

String

Строка, содержащая имя или значение для преобразования.

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

TEnum

Объект типа TEnum, значение которого представлено параметром value.

Исключения

ArgumentException

Параметр TEnum не является типом Enum.

ArgumentNullException

value имеет значение null.

ArgumentException

value не содержит сведения о перечислении.

InvalidOperationException

.NET 8 и более поздних версий: TEnum является логическим типом перечисления.