Enum.TryParse Método

Definición

Espacio de nombres:

System

Ensamblado:

System.Runtime.dll

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente. El valor devuelto indica si la conversión se realizó correctamente.

Sobrecargas

TryParse(Type, ReadOnlySpan<Char>, Object)	Convierte el intervalo de caracteres de representación del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente.
TryParse(Type, String, Object)	Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente.
TryParse(Type, ReadOnlySpan<Char>, Boolean, Object)	Convierte el intervalo de caracteres de representación 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.
TryParse(Type, String, Boolean, Object)	Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente.
TryParse<TEnum>(ReadOnlySpan<Char>, TEnum)	Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente.
TryParse<TEnum>(String, TEnum)	Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente. El valor devuelto indica si la conversión se realizó correctamente.
TryParse<TEnum>(String, Boolean, TEnum)	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 distingue mayúsculas de minúsculas. El valor devuelto indica si la conversión se realizó correctamente.
TryParse<TEnum>(ReadOnlySpan<Char>, Boolean, TEnum)	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 distingue mayúsculas de minúsculas. El valor devuelto indica si la conversión se realizó correctamente.

TryParse(Type, ReadOnlySpan<Char>, Object)

Source:

Enum.cs

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

public:
 static bool TryParse(Type ^ enumType, ReadOnlySpan<char> value, [Runtime::InteropServices::Out] System::Object ^ % result);

public static bool TryParse (Type enumType, ReadOnlySpan<char> value, out object? result);

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

Public Shared Function TryParse (enumType As Type, value As ReadOnlySpan(Of Char), ByRef result As Object) As Boolean

Parámetros

enumType

Type

Tipo de enumeración que se va a usar para el análisis.

value

ReadOnlySpan<Char>

Representación de intervalo del nombre o valor numérico de una o varias constantes enumeradas.

result

Object

Cuando este método devuelve true, contiene una constante de enumeración que representa el valor analizado.

Devoluciones

Boolean

true si la conversión se realizó correctamente; false de lo contrario.

Excepciones

InvalidOperationException

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

TryParse(Type, String, Object)

Source:

Enum.cs

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 bool TryParse(Type ^ enumType, System::String ^ value, [Runtime::InteropServices::Out] System::Object ^ % result);

public static bool TryParse (Type enumType, string? value, out object? result);

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

Public Shared Function TryParse (enumType As Type, value As String, ByRef result As Object) As Boolean

Parámetros

enumType

Type

Tipo de enumeración que se va a usar para el análisis.

value

String

Representación de cadena del nombre o valor numérico de una o varias constantes enumeradas.

result

Object

Cuando este método devuelve true, contiene una constante de enumeración que representa el valor analizado.

Devoluciones

Boolean

true si la conversión se realizó correctamente; false de lo contrario.

Excepciones

InvalidOperationException

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

TryParse(Type, ReadOnlySpan<Char>, Boolean, Object)

Source:

Enum.cs

Convierte el intervalo de caracteres de representación 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 bool TryParse(Type ^ enumType, ReadOnlySpan<char> value, bool ignoreCase, [Runtime::InteropServices::Out] System::Object ^ % result);

public static bool TryParse (Type enumType, ReadOnlySpan<char> value, bool ignoreCase, out object? result);

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

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

Parámetros

enumType

Type

Tipo de enumeración que se va a usar para el análisis.

value

ReadOnlySpan<Char>

Representación de intervalo del nombre o valor numérico de una o varias constantes enumeradas.

ignoreCase

Boolean

true leer enumType en modo sin distinción entre mayúsculas y minúsculas; false leer enumType en modo de distinción entre mayúsculas y minúsculas.

result

Object

Cuando este método devuelve true, contiene una constante de enumeración que representa el valor analizado.

Devoluciones

Boolean

true si la conversión se realizó correctamente; false de lo contrario.

Excepciones

InvalidOperationException

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

TryParse(Type, String, Boolean, Object)

Source:

Enum.cs

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 bool TryParse(Type ^ enumType, System::String ^ value, bool ignoreCase, [Runtime::InteropServices::Out] System::Object ^ % result);

public static bool TryParse (Type enumType, string? value, bool ignoreCase, out object? result);

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

Public Shared Function TryParse (enumType As Type, value As String, ignoreCase As Boolean, ByRef result As Object) As Boolean

Parámetros

enumType

Type

Tipo de enumeración que se va a usar para el análisis.

value

String

Representación de cadena del nombre o valor numérico de una o varias constantes enumeradas.

ignoreCase

Boolean

true leer value en modo sin distinción entre mayúsculas y minúsculas; false leer value en modo de distinción entre mayúsculas y minúsculas.

result

Object

Cuando este método devuelve true, contiene una constante de enumeración que representa el valor analizado.

Devoluciones

Boolean

true si la conversión se realizó correctamente; false de lo contrario.

Excepciones

InvalidOperationException

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

TryParse<TEnum>(ReadOnlySpan<Char>, TEnum)

Source:

Enum.cs

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

public:
generic <typename TEnum>
 where TEnum : value class static bool TryParse(ReadOnlySpan<char> value, [Runtime::InteropServices::Out] TEnum % result);

public static bool TryParse<TEnum> (ReadOnlySpan<char> value, out TEnum result) where TEnum : struct;

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

Public Shared Function TryParse(Of TEnum As Structure) (value As ReadOnlySpan(Of Char), ByRef result As TEnum) As Boolean

Parámetros de tipo

TEnum

Tipo del objeto result.

Parámetros

value

ReadOnlySpan<Char>

Representación de intervalo del nombre o valor numérico de una o varias constantes enumeradas.

result

TEnum

Cuando este método devuelve true, contiene una constante de enumeración que representa el valor analizado.

Devoluciones

Boolean

true si la conversión se realizó correctamente; false de lo contrario.

Excepciones

ArgumentException

TEnum no es un tipo de enumeración.

InvalidOperationException

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

TryParse<TEnum>(String, TEnum)

Source:

Enum.cs

Convierte la representación de cadena del nombre o valor numérico de una o varias constantes enumeradas en un objeto enumerado equivalente. El valor devuelto indica si la conversión se realizó correctamente.

public:
generic <typename TEnum>
 where TEnum : value class static bool TryParse(System::String ^ value, [Runtime::InteropServices::Out] TEnum % result);

public static bool TryParse<TEnum> (string? value, out TEnum result) where TEnum : struct;

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

Public Shared Function TryParse(Of TEnum As Structure) (value As String, ByRef result As TEnum) As Boolean

Parámetros de tipo

TEnum

Tipo de enumeración al que se va a convertir value.

Parámetros

value

String

Representación de cadena con distinción entre mayúsculas y minúsculas del nombre de enumeración o del valor subyacente que se va a convertir.

result

TEnum

Cuando este método devuelve , contiene un objeto de tipo TEnum cuyo valor se representa mediante value si la operación de análisis se realiza correctamente. Si se produce un error en la operación de análisis, contiene el valor predeterminado del tipo subyacente de TEnum. Este parámetro se pasa sin inicializar.

Devoluciones

Boolean

true si el parámetro value se convirtió correctamente; de lo contrario, false.

Excepciones

ArgumentException

TEnum no es un tipo de enumeración.

InvalidOperationException

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

Ejemplos

En el ejemplo siguiente se define una enumeración Colors, se llama al método TryParse<TEnum>(String, TEnum) para convertir cadenas en sus valores de enumeración correspondientes y llama al método IsDefined para asegurarse de que determinados valores enteros son valores subyacentes en la enumeración 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)
      {
         Colors colorValue;
         if (Enum.TryParse(colorString, out colorValue))
            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);
         else
            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
    match Enum.TryParse colorString with
    | true, colorValue ->
        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."
    | _ ->
        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
         Dim colorValue As Colors
         If [Enum].TryParse(colorString, colorValue) Then        
            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                    
         Else
            Console.WriteLine("{0} is not a member of the Colors enumeration.", colorString)
         End If
      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.

Comentarios

TryParse<TEnum>(String, TEnum) es idéntico al método Parse(Type, String), excepto que, en lugar de producir una excepción, devuelve false si se produce un error en la conversión. Elimina la necesidad de controlar excepciones al analizar la representación de cadena de un valor de enumeración.

El parámetro value 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 o valores subyacentes delimitados por comas (,). Si value incluye varias constantes o valores con nombre, uno o varios espacios en blanco pueden preceder o seguir cada valor, nombre o coma en value. Si value es una lista, result refleja el valor de los nombres especificados o los valores subyacentes combinados con una operación OR bit a bit. Si value es la representación de cadena del nombre de un valor de enumeración, la comparación de value con nombres de enumeración distingue mayúsculas de minúsculas.

Si value es un nombre que no corresponde a una constante con nombre de TEnum, el método devuelve false. Si value es la representación de cadena de un entero que no representa un valor subyacente de la enumeración TEnum, 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 método IsDefined para asegurarse de que una representación de cadena determinada de un entero es realmente miembro de TEnum.

Si se produce un error en la operación de análisis, el parámetro result contiene el valor predeterminado de 0, que puede no ser miembro de la enumeración TEnum subyacente. Si no se asigna ningún valor a las constantes con nombre en TEnum, el valor predeterminado es igual al primer miembro del TEnum. De lo contrario, el valor predeterminado es igual al miembro de la enumeración con un valor asignado de 0.

Consulte también

• Parse(Type, String)

TryParse<TEnum>(String, Boolean, TEnum)

Source:

Enum.cs

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 distingue mayúsculas de minúsculas. El valor devuelto indica si la conversión se realizó correctamente.

public:
generic <typename TEnum>
 where TEnum : value class static bool TryParse(System::String ^ value, bool ignoreCase, [Runtime::InteropServices::Out] TEnum % result);

public static bool TryParse<TEnum> (string? value, bool ignoreCase, out TEnum result) where TEnum : struct;

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

Public Shared Function TryParse(Of TEnum As Structure) (value As String, ignoreCase As Boolean, ByRef result As TEnum) As Boolean

Parámetros de tipo

TEnum

Tipo de enumeración al que se va a convertir value.

Parámetros

value

String

Representación de cadena del nombre de enumeración o valor subyacente que se va a convertir.

ignoreCase

Boolean

true omitir mayúsculas y minúsculas; false tener en cuenta el caso.

result

TEnum

Cuando este método devuelve , contiene un objeto de tipo TEnum cuyo valor se representa mediante value si la operación de análisis se realiza correctamente. Si se produce un error en la operación de análisis, contiene el valor predeterminado del tipo subyacente de TEnum. Este parámetro se pasa sin inicializar.

Devoluciones

Boolean

true si el parámetro value se convirtió correctamente; de lo contrario, false.

Excepciones

ArgumentException

TEnum no es un tipo de enumeración.

InvalidOperationException

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

Ejemplos

En el ejemplo siguiente se define una enumeración Colors, se llama al método TryParse<TEnum>(String, Boolean, TEnum) para convertir cadenas en sus valores de enumeración correspondientes y llama al método IsDefined para asegurarse de que determinados valores enteros son valores subyacentes en la enumeración Colors. El método TryParse<TEnum>(String, Boolean, TEnum) usa la comparación sin distinción entre mayúsculas y minúsculas al intentar convertir las representaciones de cadena de constantes con nombre en sus valores de enumeración equivalentes.

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)
      {
         Colors colorValue;
         if (Enum.TryParse(colorString, true, out colorValue))
            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);
         else
            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
    match Enum.TryParse(colorString, true) with
    | true, colorValue ->
        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."
    | _ ->
        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
         Dim colorValue As Colors
         If [Enum].TryParse(colorString, True, colorValue) Then        
            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                    
         Else
            Console.WriteLine("{0} is not a member of the Colors enumeration.", colorString)
         End If
      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

TryParse<TEnum>(String, Boolean, TEnum) es idéntico al método Parse(Type, String, Boolean), excepto que, en lugar de producir una excepción, devuelve false si se produce un error en la conversión. Elimina la necesidad de controlar excepciones al analizar la representación de cadena de un valor de enumeración.

El parámetro value 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 o valores subyacentes delimitados por comas (,). Si value incluye varias constantes o valores con nombre, uno o varios espacios en blanco pueden preceder o seguir cada valor, nombre o coma en value. Si value es una lista, result refleja el valor de los nombres especificados o los valores subyacentes combinados con una operación OR bit a bit. Si value es la representación de cadena del nombre de un valor de enumeración, la comparación de value con nombres de enumeración depende del parámetro ignoreCase. Si true, la comparación no distingue mayúsculas de minúsculas; si false, distingue mayúsculas de minúsculas.

Si value es un nombre que no corresponde a una constante con nombre de TEnum, el método devuelve false. Si value es la representación de cadena de un entero que no representa un valor subyacente de la enumeración TEnum, 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 método IsDefined para asegurarse de que una representación de cadena determinada de un entero es realmente miembro de TEnum.

Si se produce un error en la operación de análisis, el parámetro result contiene el valor predeterminado de 0, que puede no ser miembro de la enumeración TEnum subyacente. Si no se asigna ningún valor a las constantes con nombre en TEnum, el valor predeterminado es igual al primer miembro del TEnum. De lo contrario, el valor predeterminado es igual al miembro de la enumeración con un valor asignado de 0.

Consulte también

• Parse(Type, String, Boolean)

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

Source:

Enum.cs

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 distingue mayúsculas de minúsculas. El valor devuelto indica si la conversión se realizó correctamente.

public:
generic <typename TEnum>
 where TEnum : value class static bool TryParse(ReadOnlySpan<char> value, bool ignoreCase, [Runtime::InteropServices::Out] TEnum % result);

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

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

Public Shared Function TryParse(Of TEnum As Structure) (value As ReadOnlySpan(Of Char), ignoreCase As Boolean, ByRef result As TEnum) As Boolean

Parámetros de tipo

TEnum

Tipo del objeto result.

Parámetros

value

ReadOnlySpan<Char>

Representación de intervalo del nombre o valor numérico de una o varias constantes enumeradas.

ignoreCase

Boolean

true omitir mayúsculas y minúsculas; false tener en cuenta el caso.

result

TEnum

Cuando este método devuelve true, contiene una constante de enumeración que representa el valor analizado.

Devoluciones

Boolean

true si la conversión se realizó correctamente; false de lo contrario.

Excepciones

ArgumentException

TEnum no es un tipo de enumeración.

InvalidOperationException

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