Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object.
Assembly: mscorlib (in mscorlib.dll)
<ComVisibleAttribute(True)> _ Public Shared Function Parse ( _ enumType As Type, _ value As String _ ) As Object
[ComVisibleAttribute(true)] public static Object Parse( Type enumType, string value )
[ComVisibleAttribute(true)] public: static Object^ Parse( Type^ enumType, String^ value )
[<ComVisibleAttribute(true)>] static member Parse : enumType:Type * value:string -> Object
Parameters
- enumType
- Type: System.Type
An enumeration type.
- value
- Type: System.String
A string containing the name or value to convert.
| Exception | Condition |
|---|---|
| ArgumentNullException |
enumType or value is null. |
| ArgumentException |
enumType is not an Enum. -or- value is either an empty string or only contains white space. -or- value is a name, but not one of the named constants defined for the enumeration. |
| OverflowException |
value is outside the range of the underlying type of enumType. |
The value parameter contains the string representation of an enumeration member's underlying value or named constant, or a list of named constants delimited by commas (,). One or more blank spaces can precede or follow each value, name, or comma in value. If value is a list, the return value is the value of the specified names combined with a bitwise OR operation.
If value is a name that does not correspond to a named constant of enumType, the method throws an ArgumentException. If value is the string representation of an integer that does not represent an underlying value of the enumType enumeration, the method returns an enumeration member whose underlying value is value converted to an integral type. If this behavior is undesirable, call the IsDefined method to ensure that a particular string representation of an integer is actually a member of enumType. The following example defines a Colors enumeration, calls the Parse(Type, String) method to convert strings to their corresponding enumeration values, and calls the IsDefined method to ensure that particular integral values are underlying values in the Colors enumeration.
<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.
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.
This operation is case-sensitive.
The following example uses the Parse(Type, String) method to parse an array of strings that are created by calling the GetNames method. It also uses the Parse(Type, String) method to parse an enumeration value that consists of a bit field.
Imports System Public Class ParseTest <FlagsAttribute()> _ 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 '
using System; public class ParseTest { [FlagsAttribute] 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 */
using namespace System; [FlagsAttribute] 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}", myOrange ); } /* 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 */
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0.NET Framework Client Profile
Supported in: 4, 3.5 SP1Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.