Enum.Parse Método

Definición

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente.

Sobrecargas

Parse(Type, ReadOnlySpan<Char>)

Convierte el intervalo de caracteres que representa el nombre o el valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente.

Parse(Type, String)

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente.

Parse(Type, ReadOnlySpan<Char>, Boolean)

Convierte el intervalo de caracteres que representa el nombre o el valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente. Un parámetro especifica si la operación no distingue mayúsculas de minúsculas.

Parse(Type, String, Boolean)

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente. Un parámetro especifica si la operación no distingue mayúsculas de minúsculas.

Parse<TEnum>(String, Boolean)

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas especificadas por TEnum en un objeto enumerado equivalente. Un parámetro especifica si la operación no distingue mayúsculas de minúsculas.

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

Convierte el intervalo de caracteres que representa el nombre o el valor numérico de una o varias constantes enumeradas especificadas por TEnum en un objeto enumerado equivalente. Un parámetro especifica si la operación no distingue mayúsculas de minúsculas.

Parse<TEnum>(ReadOnlySpan<Char>)

Convierte el intervalo de caracteres que representa el nombre o el valor numérico de una o varias constantes enumeradas especificadas por TEnum en un objeto enumerado equivalente.

Parse<TEnum>(String)

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas especificadas por TEnum en un objeto enumerado equivalente.

Parse(Type, ReadOnlySpan<Char>)

Convierte el intervalo de caracteres que representa el nombre o el valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente.

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

Parámetros

enumType
Type

Tipo de enumeración.

value
ReadOnlySpan<Char>

Intervalo que contiene el nombre o el valor que se va a convertir.

Devoluciones

Objeto de tipo enumType cuyo valor está representado por value.

Excepciones

enumType es null.

enumType no es Enum.

value es una cadena vacía o solo contiene espacios en blanco.

value es un nombre, pero no una de las constantes con nombre definidas para la enumeración.

value está fuera del intervalo del tipo subyacente de enumType.

.NET 8 y versiones posteriores: enumType es un tipo de enumeración con respaldo booleano.

Se aplica a

Parse(Type, String)

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente.

public:
 static System::Object ^ Parse(Type ^ enumType, System::String ^ value);
public static object Parse (Type enumType, string value);
[System.Runtime.InteropServices.ComVisible(true)]
public static object Parse (Type enumType, string value);
static member Parse : Type * string -> obj
[<System.Runtime.InteropServices.ComVisible(true)>]
static member Parse : Type * string -> obj
Public Shared Function Parse (enumType As Type, value As String) As Object

Parámetros

enumType
Type

Tipo de enumeración.

value
String

Cadena que contiene el nombre o valor que se va a convertir.

Devoluciones

Objeto de tipo enumType cuyo valor está representado por value.

Atributos

Excepciones

enumType o value es null.

enumType no es un objeto Enum.

o bien

value es una cadena vacía o solo contiene espacios en blanco.

o bien

value es un nombre, pero no una de las constantes con nombre definidas para la enumeración.

value está fuera del intervalo del tipo subyacente de enumType.

.NET 8 y versiones posteriores: enumType es un tipo de enumeración con respaldo booleano.

Ejemplos

En el ejemplo siguiente se usa el Parse(Type, String) método para analizar una matriz de cadenas que se crean mediante una llamada al GetNames método . También usa el Parse(Type, String) método para analizar un valor de enumeración que consta de un campo de bits.

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
'

Comentarios

El value parámetro contiene la representación de cadena del valor subyacente o constante con nombre de un miembro de enumeración, o una lista de constantes con nombre delimitadas por comas (,). Uno o varios espacios en blanco pueden preceder o seguir cada valor, nombre o coma en value. Si value es una lista, el valor devuelto es el valor de los nombres especificados combinados con una operación bit a bit OR .

Si value es un nombre que no corresponde a una constante con nombre de enumType, el método produce un ArgumentException. Si value es la representación de cadena de un entero que no representa un valor subyacente de la enumType enumeración, el método devuelve un miembro de enumeración cuyo valor subyacente se value convierte en un tipo entero. Si este comportamiento no es deseable, llame al IsDefined método para asegurarse de que una representación de cadena determinada de un entero es realmente miembro de enumType. En el ejemplo siguiente se define una Colors enumeración, se llama al Parse(Type, String) método para convertir cadenas en sus valores de enumeración correspondientes y se llama al IsDefined método para asegurarse de que determinados valores enteros son valores subyacentes en la Colors enumeración.

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.

Esta operación distingue mayúsculas de minúsculas.

Consulte también

Se aplica a

Parse(Type, ReadOnlySpan<Char>, Boolean)

Convierte el intervalo de caracteres que representa el nombre o el valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente. Un parámetro especifica si la operación no distingue mayúsculas de minúsculas.

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

Parámetros

enumType
Type

Tipo de enumeración.

value
ReadOnlySpan<Char>

Intervalo que contiene el nombre o el valor que se va a convertir.

ignoreCase
Boolean

true para no distinguir entre mayúsculas y minúsculas; false para tener en cuenta la distinción entre mayúsculas y minúsculas.

Devoluciones

Objeto de tipo enumType cuyo valor está representado por value.

Excepciones

enumType es null.

enumType no es Enum.

value es una cadena vacía o solo contiene espacios en blanco.

value es un nombre, pero no una de las constantes con nombre definidas para la enumeración.

value está fuera del intervalo del tipo subyacente de enumType

.NET 8 y versiones posteriores: enumType es un tipo de enumeración con respaldo booleano.

Se aplica a

Parse(Type, String, Boolean)

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente. Un parámetro especifica si la operación no distingue mayúsculas de minúsculas.

public:
 static System::Object ^ Parse(Type ^ enumType, System::String ^ value, bool ignoreCase);
public static object Parse (Type enumType, string value, bool ignoreCase);
[System.Runtime.InteropServices.ComVisible(true)]
public static object Parse (Type enumType, string value, bool ignoreCase);
static member Parse : Type * string * bool -> obj
[<System.Runtime.InteropServices.ComVisible(true)>]
static member Parse : Type * string * bool -> obj
Public Shared Function Parse (enumType As Type, value As String, ignoreCase As Boolean) As Object

Parámetros

enumType
Type

Tipo de enumeración.

value
String

Cadena que contiene el nombre o valor que se va a convertir.

ignoreCase
Boolean

true para no distinguir entre mayúsculas y minúsculas; false para tener en cuenta la distinción entre mayúsculas y minúsculas.

Devoluciones

Objeto de tipo enumType cuyo valor está representado por value.

Atributos

Excepciones

enumType o value es null.

enumType no es un objeto Enum.

o bien

value es una cadena vacía ("") o solo contiene espacios en blanco.

o bien

value es un nombre, pero no una de las constantes con nombre definidas para la enumeración.

value está fuera del intervalo del tipo subyacente de enumType.

.NET 8 y versiones posteriores: enumType es un tipo de enumeración con respaldo booleano.

Ejemplos

En el ejemplo siguiente se usa el Parse(Type, String, Boolean) método para analizar una matriz de cadenas que se crean mediante una llamada al GetNames método . También usa el Parse(Type, String) método para analizar un valor de enumeración que consta de un campo de bits.

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.

Comentarios

El value parámetro contiene la representación de cadena del valor subyacente o constante con nombre de un miembro de enumeración, o una lista de constantes con nombre delimitadas por comas (,). Uno o varios espacios en blanco pueden preceder o seguir cada valor, nombre o coma en value. Si value es una lista, el valor devuelto es el valor de los nombres especificados combinados con una operación bit a bit OR .

Si value es un nombre que no corresponde a una constante con nombre de enumType, el método produce un ArgumentException. Si value es la representación de cadena de un entero que no representa un valor subyacente de la enumType enumeración, el método devuelve un miembro de enumeración cuyo valor subyacente se value convierte en un tipo entero. Si este comportamiento no es deseable, llame al IsDefined método para asegurarse de que una representación de cadena determinada de un entero es realmente miembro de enumType. En el ejemplo siguiente se define una Colors enumeración, se llama al Parse(Type, String, Boolean) método para convertir cadenas en sus valores de enumeración correspondientes y se llama al IsDefined método para asegurarse de que determinados valores enteros son valores subyacentes en la Colors enumeración.

El ignoreCase parámetro especifica si esta operación distingue mayúsculas de minúsculas.

Consulte también

Se aplica a

Parse<TEnum>(String, Boolean)

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas especificadas por TEnum en un objeto enumerado equivalente. Un parámetro especifica si la operación no distingue mayúsculas de minúsculas.

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

Parámetros de tipo

TEnum

Tipo de enumeración.

Parámetros

value
String

Cadena que contiene el nombre o valor que se va a convertir.

ignoreCase
Boolean

true para no distinguir entre mayúsculas y minúsculas; false para tener en cuenta la distinción entre mayúsculas y minúsculas.

Devoluciones

TEnum

Objeto de tipo TEnum cuyo valor está representado por value.

Excepciones

TEnum no es un tipo Enum.

value es null.

value no contiene información de enumeración.

.NET 8 y versiones posteriores: TEnum es un tipo de enumeración con respaldo booleano.

Se aplica a

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

Convierte el intervalo de caracteres que representa el nombre o el valor numérico de una o varias constantes enumeradas especificadas por TEnum en un objeto enumerado equivalente. Un parámetro especifica si la operación no distingue mayúsculas de minúsculas.

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

Parámetros de tipo

TEnum

Tipo de enumeración.

Parámetros

value
ReadOnlySpan<Char>

Intervalo que contiene el nombre o el valor que se va a convertir.

ignoreCase
Boolean

true para no distinguir entre mayúsculas y minúsculas; false para tener en cuenta la distinción entre mayúsculas y minúsculas.

Devoluciones

TEnum

TEnum Objeto de tipo TEnum cuyo valor se representa mediante value.

Excepciones

TEnum no es un tipo Enum.

value no contiene información de enumeración.

.NET 8 y versiones posteriores: TEnum es un tipo de enumeración con respaldo booleano.

Se aplica a

Parse<TEnum>(ReadOnlySpan<Char>)

Convierte el intervalo de caracteres que representa el nombre o el valor numérico de una o varias constantes enumeradas especificadas por TEnum en un objeto enumerado equivalente.

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

Parámetros de tipo

TEnum

Tipo de enumeración.

Parámetros

value
ReadOnlySpan<Char>

Intervalo que contiene el nombre o el valor que se va a convertir.

Devoluciones

TEnum

TEnum Objeto de tipo TEnum cuyo valor se representa mediante value.

Excepciones

TEnum no es un tipo Enum.

value no contiene información de enumeración.

.NET 8 y versiones posteriores: TEnum es un tipo de enumeración con respaldo booleano.

Se aplica a

Parse<TEnum>(String)

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas especificadas por TEnum en un objeto enumerado equivalente.

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

Parámetros de tipo

TEnum

Tipo de enumeración.

Parámetros

value
String

Cadena que contiene el nombre o valor que se va a convertir.

Devoluciones

TEnum

Objeto de tipo TEnum cuyo valor está representado por value.

Excepciones

TEnum no es un tipo Enum.

value es null.

value no contiene información de enumeración.

.NET 8 y versiones posteriores: TEnum es un tipo de enumeración con respaldo booleano.

Se aplica a