Enum.TryParse Método

Definição

Converte a representação da cadeia de caracteres do nome ou do valor numérico de uma ou mais constantes enumeradas em um objeto enumerado equivalente.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. O valor de retorno indica se a conversão foi bem-sucedida.The return value indicates whether the conversion succeeded.

Sobrecargas

TryParse(Type, String, Object)

Converte a representação da cadeia de caracteres do nome ou do valor numérico de uma ou mais constantes enumeradas em um objeto enumerado equivalente.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object.

TryParse(Type, String, Boolean, Object)

Converte a representação da cadeia de caracteres do nome ou do valor numérico de uma ou mais constantes enumeradas em um objeto enumerado equivalente.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object.

TryParse<TEnum>(String, Boolean, TEnum)

Converte a representação da cadeia de caracteres do nome ou do valor numérico de uma ou mais constantes enumeradas em um objeto enumerado equivalente.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. Um parâmetro especifica se a operação diferencia maiúsculas de minúsculas.A parameter specifies whether the operation is case-sensitive. O valor de retorno indica se a conversão foi bem-sucedida.The return value indicates whether the conversion succeeded.

TryParse<TEnum>(String, TEnum)

Converte a representação da cadeia de caracteres do nome ou do valor numérico de uma ou mais constantes enumeradas em um objeto enumerado equivalente.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. O valor de retorno indica se a conversão foi bem-sucedida.The return value indicates whether the conversion succeeded.

TryParse(Type, String, Object)

Converte a representação da cadeia de caracteres do nome ou do valor numérico de uma ou mais constantes enumeradas em um objeto enumerado equivalente.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object.

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

O tipo enumerado a ser usado para a análise.The enum type to use for parsing.

value
String

A representação da cadeia de caracteres do nome ou do valor numérico de uma ou mais constantes enumeradas.The string representation of the name or numeric value of one or more enumerated constants.

result
Object

Quando esse método retorna true, um objeto que contém uma constante de enumeração que representa o valor analisado.When this method returns true, an object containing an enumeration constant representing the parsed value.

Retornos

Boolean

true se a conversão foi bem-sucedida, caso contrário, false.true if the conversion succeeded; false otherwise.

Aplica-se a

TryParse(Type, String, Boolean, Object)

Converte a representação da cadeia de caracteres do nome ou do valor numérico de uma ou mais constantes enumeradas em um objeto enumerado equivalente.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object.

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

O tipo enumerado a ser usado para a análise.The enum type to use for parsing.

value
String

A representação da cadeia de caracteres do nome ou do valor numérico de uma ou mais constantes enumeradas.The string representation of the name or numeric value of one or more enumerated constants.

ignoreCase
Boolean

true para ler value no modo que não diferencia maiúsculas de minúsculas; false para ler value no modo que diferencia maiúsculas de minúsculas.true to read value in case insensitive mode; false to read value in case sensitive mode.

result
Object

Quando esse método retorna true, um objeto que contém uma constante de enumeração que representa o valor analisado.When this method returns true, an object containing an enumeration constant representing the parsed value.

Retornos

Boolean

true se a conversão foi bem-sucedida, caso contrário, false.true if the conversion succeeded; false otherwise.

Aplica-se a

TryParse<TEnum>(String, Boolean, TEnum)

Converte a representação da cadeia de caracteres do nome ou do valor numérico de uma ou mais constantes enumeradas em um objeto enumerado equivalente.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. Um parâmetro especifica se a operação diferencia maiúsculas de minúsculas.A parameter specifies whether the operation is case-sensitive. O valor de retorno indica se a conversão foi bem-sucedida.The return value indicates whether the conversion succeeded.

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

O tipo de enumeração para o qual value será convertido.The enumeration type to which to convert value.

Parâmetros

value
String

A representação de cadeia de caracteres do nome de enumeração ou do valor subjacente a ser convertido.The string representation of the enumeration name or underlying value to convert.

ignoreCase
Boolean

true para ignorar as maiúsculas e minúsculas, false considerar as maiúsculas e minúsculas.true to ignore case; false to consider case.

result
TEnum

Quando esse método retorna, result contém um objeto do tipo TEnum cujo valor é representado por value caso a operação de análise seja bem-sucedida.When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. Se a operação de análise falhar, result conterá o valor padrão do tipo subjacente de TEnum.If the parse operation fails, result contains the default value of the underlying type of TEnum. Observe que esse valor não precisa ser membro da enumeração TEnum.Note that this value need not be a member of the TEnum enumeration. Este parâmetro é passado não inicializado.This parameter is passed uninitialized.

Retornos

Boolean

true caso o parâmetro value tenha sido convertido com êxito; do contrário, false.true if the value parameter was converted successfully; otherwise, false.

Exceções

TEnum não é um tipo de enumeração.TEnum is not an enumeration type.

Exemplos

O exemplo a seguir define uma Colors enumeração, chama o TryParse<TEnum>(String, Boolean, TEnum) método para converter cadeias de caracteres em seus valores de enumeração correspondentes e chama o IsDefined método para garantir que valores integrais específicos sejam valores subjacentes na Colors enumeração.The following example defines a Colors enumeration, calls the TryParse<TEnum>(String, Boolean, TEnum) 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. O TryParse<TEnum>(String, Boolean, TEnum) método usa a comparação de maiúsculas e minúsculas ao tentar converter as representações de cadeia de caracteres de constantes nomeadas em seus valores de enumeração equivalentes.The TryParse<TEnum>(String, Boolean, TEnum) method uses case-insensitive comparison when trying to convert the string representations of named constants to their equivalent enumeration values.

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

Comentários

TryParse<TEnum>(String, Boolean, TEnum) é idêntico ao Parse(Type, String, Boolean) método, exceto que, em vez de lançar uma exceção, ele retorna false se a conversão falha.TryParse<TEnum>(String, Boolean, TEnum) is identical to the Parse(Type, String, Boolean) method, except that instead of throwing an exception, it returns false if the conversion fails. Ele elimina a necessidade de tratamento de exceção ao analisar a representação de cadeia de caracteres de um valor de enumeração.It eliminates the need for exception handling when parsing the string representation of an enumeration value.

O value parâmetro contém a representação de cadeia de caracteres de um valor subjacente de um membro de enumeração ou uma constante nomeada, ou uma lista de constantes nomeadas ou valores subjacente delimitados por vírgulas (,).The value parameter contains the string representation of an enumeration member's underlying value or named constant, or a list of named constants or underlying values delimited by commas (,). Se o value incluir várias constantes nomeadas ou valores, um ou mais espaços em branco poderão preceder ou seguir cada valor, nome ou vírgula em value .If value includes multiple named constants or values, one or more blank spaces can precede or follow each value, name, or comma in value. Se value for uma lista, result refletirá o valor dos nomes especificados ou os valores subjacentes combinados com uma operação bit-a-bit OR .If value is a list, result reflects the value of the specified names or underlying values combined with a bitwise OR operation. Se value for a representação de cadeia de caracteres do nome de um valor de enumeração, a comparação de value com nomes de enumeração dependerá do ignoreCase parâmetro.If value is the string representation of the name of an enumeration value, the comparison of value with enumeration names depends on the ignoreCase parameter. Se true , a comparação não diferencia maiúsculas de minúsculas; se false , diferencia maiúsculas de minúsculas.If true, the comparison is case-insensitive; if false, it is case-sensitive.

Se value for um nome que não corresponde a uma constante nomeada de TEnum , o método retornará false .If value is a name that does not correspond to a named constant of TEnum, the method returns false. Se value é a representação de cadeia de caracteres de um inteiro que não representa um valor subjacente da TEnum enumeração, o método retorna um membro de enumeração cujo valor subjacente é value convertido em um tipo integral.If value is the string representation of an integer that does not represent an underlying value of the TEnum enumeration, the method returns an enumeration member whose underlying value is value converted to an integral type. Se esse comportamento for indesejável, chame o IsDefined método para garantir que uma representação de cadeia de caracteres específica de um inteiro seja, na verdade, um membro de TEnum .If this behavior is undesirable, call the IsDefined method to ensure that a particular string representation of an integer is actually a member of TEnum.

Confira também

Aplica-se a

TryParse<TEnum>(String, TEnum)

Converte a representação da cadeia de caracteres do nome ou do valor numérico de uma ou mais constantes enumeradas em um objeto enumerado equivalente.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. O valor de retorno indica se a conversão foi bem-sucedida.The return value indicates whether the conversion succeeded.

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

O tipo de enumeração para o qual value será convertido.The enumeration type to which to convert value.

Parâmetros

value
String

A representação de cadeia de caracteres que diferencia maiúsculas de minúsculas do nome de enumeração ou do valor subjacente a ser convertido.The case-sensitive string representation of the enumeration name or underlying value to convert.

result
TEnum

Quando esse método retorna, result contém um objeto do tipo TEnum cujo valor é representado por value caso a operação de análise seja bem-sucedida.When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. Se a operação de análise falhar, result conterá o valor padrão do tipo subjacente de TEnum.If the parse operation fails, result contains the default value of the underlying type of TEnum. Observe que esse valor não precisa ser membro da enumeração TEnum.Note that this value need not be a member of the TEnum enumeration. Este parâmetro é passado não inicializado.This parameter is passed uninitialized.

Retornos

Boolean

true caso o parâmetro value tenha sido convertido com êxito; do contrário, false.true if the value parameter was converted successfully; otherwise, false.

Exceções

TEnum não é um tipo de enumeração.TEnum is not an enumeration type.

Exemplos

O exemplo a seguir define uma Colors enumeração, chama o TryParse<TEnum>(String, TEnum) método para converter cadeias de caracteres em seus valores de enumeração correspondentes e chama o IsDefined método para garantir que valores integrais específicos sejam valores subjacentes na Colors enumeração.The following example defines a Colors enumeration, calls the TryParse<TEnum>(String, TEnum) 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.

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

Comentários

TryParse<TEnum>(String, TEnum) é idêntico ao Parse(Type, String) método, exceto que, em vez de lançar uma exceção, ele retorna false se a conversão falha.TryParse<TEnum>(String, TEnum) is identical to the Parse(Type, String) method, except that instead of throwing an exception, it returns false if the conversion fails. Ele elimina a necessidade de tratamento de exceção ao analisar a representação de cadeia de caracteres de um valor de enumeração.It eliminates the need for exception handling when parsing the string representation of an enumeration value.

O value parâmetro contém a representação de cadeia de caracteres de um valor subjacente de um membro de enumeração ou uma constante nomeada, ou uma lista de constantes nomeadas ou valores subjacente delimitados por vírgulas (,).The value parameter contains the string representation of an enumeration member's underlying value or named constant, or a list of named constants or underlying values delimited by commas (,). Se o value incluir várias constantes nomeadas ou valores, um ou mais espaços em branco poderão preceder ou seguir cada valor, nome ou vírgula em value .If value includes multiple named constants or values, one or more blank spaces can precede or follow each value, name, or comma in value. Se value for uma lista, result refletirá o valor dos nomes especificados ou os valores subjacentes combinados com uma operação bit-a-bit OR .If value is a list, result reflects the value of the specified names or underlying values combined with a bitwise OR operation. Se value é a representação de cadeia de caracteres do nome de um valor de enumeração, a comparação de value com nomes de enumeração diferencia maiúsculas de minúsculas.If value is the string representation of the name of an enumeration value, the comparison of value with enumeration names is case-sensitive.

Se value for um nome que não corresponde a uma constante nomeada de TEnum , o método retornará false .If value is a name that does not correspond to a named constant of TEnum, the method returns false. Se value é a representação de cadeia de caracteres de um inteiro que não representa um valor subjacente da TEnum enumeração, o método retorna um membro de enumeração cujo valor subjacente é value convertido em um tipo integral.If value is the string representation of an integer that does not represent an underlying value of the TEnum enumeration, the method returns an enumeration member whose underlying value is value converted to an integral type. Se esse comportamento for indesejável, chame o IsDefined método para garantir que uma representação de cadeia de caracteres específica de um inteiro seja, na verdade, um membro de TEnum .If this behavior is undesirable, call the IsDefined method to ensure that a particular string representation of an integer is actually a member of TEnum.

Confira também

Aplica-se a