Enum.Parse 方法

定义

将一个或多个枚举常量的名称或数值的名称或数值的字符串表示形式转换为等效的枚举对象。

重载

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

Source:
Enum.cs
Source:
Enum.cs
Source:
Enum.cs

将一个或多个枚举常量的名称或数值的名称或数值的字符表示形式转换为等效的枚举对象。

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

参数

enumType
Type

枚举类型。

value
ReadOnlySpan<Char>

包含要转换的名称或值范围。

返回

类型 enumType 的对象,其值由 value表示。

例外

enumType null

enumType 不是 Enum

value 为空字符串或仅包含空格。

value 是一个名称,但不是为枚举定义的命名常量之一。

value 超出了基础类型的 enumType范围。

.NET 8 及更高版本:enumType 是布尔支持的枚举类型。

适用于

.NET 9 和其他版本
产品 版本
.NET 6, 7, 8, 9

Parse(Type, String)

Source:
Enum.cs
Source:
Enum.cs
Source:
Enum.cs

将一个或多个枚举常量的名称或数值的名称或数值的字符串表示形式转换为等效的枚举对象。

C#
public static object Parse (Type enumType, string value);
C#
[System.Runtime.InteropServices.ComVisible(true)]
public static object Parse (Type enumType, string value);

参数

enumType
Type

枚举类型。

value
String

包含要转换的名称或值的字符串。

返回

类型 enumType 的对象,其值由 value表示。

属性

例外

enumTypevaluenull

enumType 不是 Enum

-或-

value 为空字符串或仅包含空格。

-或-

value 是一个名称,但不是为枚举定义的命名常量之一。

value 超出了基础类型的 enumType范围。

.NET 8 及更高版本:enumType 是布尔支持的枚举类型。

示例

以下示例使用 Parse(Type, String) 方法分析通过调用 GetNames 方法创建的字符串数组。 它还使用 Parse(Type, String) 方法分析由位字段组成的枚举值。

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

*/

注解

value 参数包含枚举成员的基础值或命名常量的字符串表示形式,或用逗号(,)分隔的命名常量列表。 一个或多个空格可以位于 value中的每个值、名称或逗号前面或后面。 如果 value 是列表,则返回值是指定名称的值,并结合按位 OR 操作。

如果 value 的名称与 enumType的命名常量不对应,该方法将引发 ArgumentException。 如果 value 是一个不表示 enumType 枚举的基础值的整数的字符串表示形式,该方法将返回一个枚举成员,其基础值 value 转换为整型类型。 如果此行为不可取,请调用 IsDefined 方法以确保整数的特定字符串表示形式实际上是 enumType的成员。 以下示例定义一个 Colors 枚举,调用 Parse(Type, String) 方法将字符串转换为其相应的枚举值,并调用 IsDefined 方法以确保特定整型值是 Colors 枚举中的基础值。

C#
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.

此操作区分大小写。

另请参阅

适用于

.NET 9 和其他版本
产品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

Parse(Type, ReadOnlySpan<Char>, Boolean)

Source:
Enum.cs
Source:
Enum.cs
Source:
Enum.cs

将一个或多个枚举常量的名称或数值的名称或数值的字符表示形式转换为等效的枚举对象。 参数指定操作是否不区分大小写。

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

参数

enumType
Type

枚举类型。

value
ReadOnlySpan<Char>

包含要转换的名称或值范围。

ignoreCase
Boolean

true 忽略大小写;false 有关案例。

返回

类型 enumType 的对象,其值由 value表示。

例外

enumType null

enumType 不是 Enum

value 为空字符串或仅包含空格。

value 是一个名称,但不是为枚举定义的命名常量之一。

value 不在基础类型的 enumType 范围内

.NET 8 及更高版本:enumType 是布尔支持的枚举类型。

适用于

.NET 9 和其他版本
产品 版本
.NET 6, 7, 8, 9

Parse(Type, String, Boolean)

Source:
Enum.cs
Source:
Enum.cs
Source:
Enum.cs

将一个或多个枚举常量的名称或数值的名称或数值的字符串表示形式转换为等效的枚举对象。 参数指定操作是否不区分大小写。

C#
public static object Parse (Type enumType, string value, bool ignoreCase);
C#
[System.Runtime.InteropServices.ComVisible(true)]
public static object Parse (Type enumType, string value, bool ignoreCase);

参数

enumType
Type

枚举类型。

value
String

包含要转换的名称或值的字符串。

ignoreCase
Boolean

true 忽略大小写;false 有关案例。

返回

类型 enumType 的对象,其值由 value表示。

属性

例外

enumTypevaluenull

enumType 不是 Enum

-或-

value 为空字符串(“”)或仅包含空格。

-或-

value 是一个名称,但不是为枚举定义的命名常量之一。

value 超出了基础类型的 enumType范围。

.NET 8 及更高版本:enumType 是布尔支持的枚举类型。

示例

以下示例使用 Parse(Type, String, Boolean) 方法分析通过调用 GetNames 方法创建的字符串数组。 它还使用 Parse(Type, String) 方法分析由位字段组成的枚举值。

C#
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.

注解

value 参数包含枚举成员的基础值或命名常量的字符串表示形式,或用逗号(,)分隔的命名常量列表。 一个或多个空格可以位于 value中的每个值、名称或逗号前面或后面。 如果 value 是列表,则返回值是指定名称的值,并结合按位 OR 操作。

如果 value 的名称与 enumType的命名常量不对应,该方法将引发 ArgumentException。 如果 value 是一个不表示 enumType 枚举的基础值的整数的字符串表示形式,该方法将返回一个枚举成员,其基础值 value 转换为整型类型。 如果此行为不可取,请调用 IsDefined 方法以确保整数的特定字符串表示形式实际上是 enumType的成员。 以下示例定义一个 Colors 枚举,调用 Parse(Type, String, Boolean) 方法将字符串转换为其相应的枚举值,并调用 IsDefined 方法以确保特定整型值是 Colors 枚举中的基础值。

ignoreCase 参数指定此操作是否区分大小写。

另请参阅

适用于

.NET 9 和其他版本
产品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

Parse<TEnum>(String, Boolean)

Source:
Enum.cs
Source:
Enum.cs
Source:
Enum.cs

TEnum 指定的一个或多个枚举常量的名称或数值的字符串表示形式转换为等效的枚举对象。 参数指定操作是否不区分大小写。

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

类型参数

TEnum

枚举类型。

参数

value
String

包含要转换的名称或值的字符串。

ignoreCase
Boolean

true 忽略大小写;false 有关案例。

返回

TEnum

类型 TEnum 的对象,其值由 value表示。

例外

TEnum 不是 Enum 类型。

value null

value 不包含枚举信息。

.NET 8 及更高版本:TEnum 是布尔支持的枚举类型。

适用于

.NET 9 和其他版本
产品 版本
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Standard 2.1

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

Source:
Enum.cs
Source:
Enum.cs
Source:
Enum.cs

TEnum 指定的一个或多个枚举常量的名称或数值的字符表示形式的范围转换为等效的枚举对象。 参数指定操作是否不区分大小写。

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

类型参数

TEnum

枚举类型。

参数

value
ReadOnlySpan<Char>

包含要转换的名称或值范围。

ignoreCase
Boolean

true 忽略大小写;false 有关案例。

返回

TEnum

TEnum 一个类型 TEnum 的对象,其值由 value表示。

例外

TEnum 不是 Enum 类型。

value 不包含枚举信息。

.NET 8 及更高版本:TEnum 是布尔支持的枚举类型。

适用于

.NET 9 和其他版本
产品 版本
.NET 6, 7, 8, 9

Parse<TEnum>(ReadOnlySpan<Char>)

Source:
Enum.cs
Source:
Enum.cs
Source:
Enum.cs

TEnum 指定的一个或多个枚举常量的名称或数值的字符表示形式的范围转换为等效的枚举对象。

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

类型参数

TEnum

枚举类型。

参数

value
ReadOnlySpan<Char>

包含要转换的名称或值范围。

返回

TEnum

TEnum 一个类型 TEnum 的对象,其值由 value表示。

例外

TEnum 不是 Enum 类型。

value 不包含枚举信息。

.NET 8 及更高版本:TEnum 是布尔支持的枚举类型。

适用于

.NET 9 和其他版本
产品 版本
.NET 6, 7, 8, 9

Parse<TEnum>(String)

Source:
Enum.cs
Source:
Enum.cs
Source:
Enum.cs

TEnum 指定的一个或多个枚举常量的名称或数值的字符串表示形式转换为等效的枚举对象。

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

类型参数

TEnum

枚举类型。

参数

value
String

包含要转换的名称或值的字符串。

返回

TEnum

类型 TEnum 的对象,其值由 value表示。

例外

TEnum 不是 Enum 类型。

value null

value 不包含枚举信息。

.NET 8 及更高版本:TEnum 是布尔支持的枚举类型。

适用于

.NET 9 和其他版本
产品 版本
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Standard 2.1