Enum.TryParse Metoda

Definicja

Konwertuje ciąg znaków reprezentujący nazwę lub wartość liczbową jednej lub więcej stałych wyliczeniowych dla równoważnego obiektu wyliczanego.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. Zwracana wartość wskazuje, czy konwersja powiodła się.The return value indicates whether the conversion succeeded.

Przeciążenia

TryParse(Type, String, Object)

Konwertuje ciąg znaków reprezentujący nazwę lub wartość liczbową jednej lub więcej stałych wyliczeniowych dla równoważnego obiektu wyliczanego.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)

Konwertuje ciąg znaków reprezentujący nazwę lub wartość liczbową jednej lub więcej stałych wyliczeniowych dla równoważnego obiektu wyliczanego.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)

Konwertuje ciąg znaków reprezentujący nazwę lub wartość liczbową jednej lub więcej stałych wyliczeniowych dla równoważnego obiektu wyliczanego.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. Parametr określa, czy w operacji jest rozróżniana wielkość liter.A parameter specifies whether the operation is case-sensitive. Zwracana wartość wskazuje, czy konwersja powiodła się.The return value indicates whether the conversion succeeded.

TryParse<TEnum>(String, TEnum)

Konwertuje ciąg znaków reprezentujący nazwę lub wartość liczbową jednej lub więcej stałych wyliczeniowych dla równoważnego obiektu wyliczanego.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. Zwracana wartość wskazuje, czy konwersja powiodła się.The return value indicates whether the conversion succeeded.

TryParse(Type, String, Object)

Konwertuje ciąg znaków reprezentujący nazwę lub wartość liczbową jednej lub więcej stałych wyliczeniowych dla równoważnego obiektu wyliczanego.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

Parametry

enumType
Type

Typ wyliczenia, który ma być używany do analizowania.The enum type to use for parsing.

value
String

Ciąg reprezentujący nazwę lub wartość liczbową jednej lub kilku stałych wyliczeniowych.The string representation of the name or numeric value of one or more enumerated constants.

result
Object

Gdy ta metoda zwraca true , obiekt zawierający stałą wyliczenia reprezentującą przeanalizowana wartość.When this method returns true, an object containing an enumeration constant representing the parsed value.

Zwraca

Boolean

true Jeśli konwersja zakończyła się pomyślnie; false w przeciwnym razie.true if the conversion succeeded; false otherwise.

Dotyczy

TryParse(Type, String, Boolean, Object)

Konwertuje ciąg znaków reprezentujący nazwę lub wartość liczbową jednej lub więcej stałych wyliczeniowych dla równoważnego obiektu wyliczanego.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

Parametry

enumType
Type

Typ wyliczenia, który ma być używany do analizowania.The enum type to use for parsing.

value
String

Ciąg reprezentujący nazwę lub wartość liczbową jednej lub kilku stałych wyliczeniowych.The string representation of the name or numeric value of one or more enumerated constants.

ignoreCase
Boolean

true Aby odczytać value w trybie bez uwzględniania wielkości liter, false należy odczytać value w trybie z uwzględnieniem wielkości liter.true to read value in case insensitive mode; false to read value in case sensitive mode.

result
Object

Gdy ta metoda zwraca true , obiekt zawierający stałą wyliczenia reprezentującą przeanalizowana wartość.When this method returns true, an object containing an enumeration constant representing the parsed value.

Zwraca

Boolean

true Jeśli konwersja zakończyła się pomyślnie; false w przeciwnym razie.true if the conversion succeeded; false otherwise.

Dotyczy

TryParse<TEnum>(String, Boolean, TEnum)

Konwertuje ciąg znaków reprezentujący nazwę lub wartość liczbową jednej lub więcej stałych wyliczeniowych dla równoważnego obiektu wyliczanego.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. Parametr określa, czy w operacji jest rozróżniana wielkość liter.A parameter specifies whether the operation is case-sensitive. Zwracana wartość wskazuje, czy konwersja powiodła się.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

Parametry typu

TEnum

Typ wyliczenia do przekonwertowania value .The enumeration type to which to convert value.

Parametry

value
String

Ciąg reprezentujący nazwę wyliczenia lub wartość bazową do przekonwertowania.The string representation of the enumeration name or underlying value to convert.

ignoreCase
Boolean

true Aby zignorować wielkość liter; false Rozważ uwzględnienie wielkości liter.true to ignore case; false to consider case.

result
TEnum

Gdy ta metoda zwraca, result zawiera obiekt typu element TEnum , którego wartość jest reprezentowana przez value Jeśli operacja analizy powiedzie się.When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. Jeśli operacja analizy zakończy się niepowodzeniem, result zawiera wartość domyślną typu element TEnum.If the parse operation fails, result contains the default value of the underlying type of TEnum. Należy zauważyć, że ta wartość nie musi być elementem członkowskim wyliczenia element TEnum .Note that this value need not be a member of the TEnum enumeration. Ten parametr jest przekazywany jako niezainicjowany.This parameter is passed uninitialized.

Zwraca

Boolean

true Jeśli value parametr został przekonwertowany pomyślnie; w przeciwnym razie, false .true if the value parameter was converted successfully; otherwise, false.

Wyjątki

TEnum nie jest typem wyliczenia.TEnum is not an enumeration type.

Przykłady

W poniższym przykładzie zdefiniowano Colors Wyliczenie, wywołuje TryParse<TEnum>(String, Boolean, TEnum) metodę w celu przekonwertowania ciągów na odpowiadające im wartości wyliczenia i wywołuje IsDefined metodę, aby upewnić się, że określone wartości całkowite są wartościami podstawowymi w Colors wyliczeniu.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. TryParse<TEnum>(String, Boolean, TEnum)Metoda używa porównania bez uwzględniania wielkości liter podczas próby przekonwertowania ciągu reprezentujący nazwane stałe na ich równoważne wartości wyliczenia.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.

Uwagi

TryParse<TEnum>(String, Boolean, TEnum) jest taka sama jak Parse(Type, String, Boolean) Metoda, z tą różnicą, że zamiast zgłaszania wyjątku, zwraca, false Jeśli konwersja nie powiedzie się.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. Eliminuje to potrzebę obsługi wyjątków podczas analizowania ciągu reprezentującego wartość wyliczenia.It eliminates the need for exception handling when parsing the string representation of an enumeration value.

valueParametr zawiera ciąg reprezentujący wartość bazową lub nazwaną stałą elementu członkowskiego wyliczenia lub listę nazwanych stałych lub wartości bazowych rozdzielanych przecinkami (,).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 (,). Jeśli value zawiera wiele nazwanych stałych lub wartości, co najmniej jedna spacja może poprzedzać lub stosować każdą wartość, nazwę lub przecinek w 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. Jeśli value jest listą, result odzwierciedla wartość określonych nazw lub wartości bazowych połączonych z operacją bitową OR .If value is a list, result reflects the value of the specified names or underlying values combined with a bitwise OR operation. Jeśli value jest to ciąg reprezentujący nazwę wartości wyliczenia, porównywanie value z nazwami wyliczenia zależy od ignoreCase parametru.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. trueW przypadku porównania nie jest rozróżniana wielkość liter; Jeśli false jest uwzględniana wielkość liter.If true, the comparison is case-insensitive; if false, it is case-sensitive.

Jeśli value jest nazwą, która nie odpowiada nazwie stałe TEnum , metoda zwraca false .If value is a name that does not correspond to a named constant of TEnum, the method returns false. Jeśli value ciąg jest reprezentacją liczby całkowitej, która nie reprezentuje bazowej wartości TEnum wyliczenia, metoda zwraca element członkowski wyliczenia, którego wartość bazowa jest value konwertowana na typ całkowity.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. Jeśli takie zachowanie jest niepożądane, wywołaj IsDefined metodę, aby upewnić się, że określony ciąg reprezentujący liczbę całkowitą jest w rzeczywistości członkiem 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.

Zobacz też

Dotyczy

TryParse<TEnum>(String, TEnum)

Konwertuje ciąg znaków reprezentujący nazwę lub wartość liczbową jednej lub więcej stałych wyliczeniowych dla równoważnego obiektu wyliczanego.Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. Zwracana wartość wskazuje, czy konwersja powiodła się.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

Parametry typu

TEnum

Typ wyliczenia do przekonwertowania value .The enumeration type to which to convert value.

Parametry

value
String

Reprezentacja ciągu z uwzględnieniem wielkości liter dla nazwy wyliczenia lub wartości bazowej do przekonwertowania.The case-sensitive string representation of the enumeration name or underlying value to convert.

result
TEnum

Gdy ta metoda zwraca, result zawiera obiekt typu element TEnum , którego wartość jest reprezentowana przez value Jeśli operacja analizy powiedzie się.When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. Jeśli operacja analizy zakończy się niepowodzeniem, result zawiera wartość domyślną typu element TEnum.If the parse operation fails, result contains the default value of the underlying type of TEnum. Należy zauważyć, że ta wartość nie musi być elementem członkowskim wyliczenia element TEnum .Note that this value need not be a member of the TEnum enumeration. Ten parametr jest przekazywany jako niezainicjowany.This parameter is passed uninitialized.

Zwraca

Boolean

true Jeśli value parametr został przekonwertowany pomyślnie; w przeciwnym razie, false .true if the value parameter was converted successfully; otherwise, false.

Wyjątki

TEnum nie jest typem wyliczenia.TEnum is not an enumeration type.

Przykłady

W poniższym przykładzie zdefiniowano Colors Wyliczenie, wywołuje TryParse<TEnum>(String, TEnum) metodę w celu przekonwertowania ciągów na odpowiadające im wartości wyliczenia i wywołuje IsDefined metodę, aby upewnić się, że określone wartości całkowite są wartościami podstawowymi w Colors wyliczeniu.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.

Uwagi

TryParse<TEnum>(String, TEnum) jest taka sama jak Parse(Type, String) Metoda, z tą różnicą, że zamiast zgłaszania wyjątku, zwraca, false Jeśli konwersja nie powiedzie się.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. Eliminuje to potrzebę obsługi wyjątków podczas analizowania ciągu reprezentującego wartość wyliczenia.It eliminates the need for exception handling when parsing the string representation of an enumeration value.

valueParametr zawiera ciąg reprezentujący wartość bazową lub nazwaną stałą elementu członkowskiego wyliczenia lub listę nazwanych stałych lub wartości bazowych rozdzielanych przecinkami (,).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 (,). Jeśli value zawiera wiele nazwanych stałych lub wartości, co najmniej jedna spacja może poprzedzać lub stosować każdą wartość, nazwę lub przecinek w 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. Jeśli value jest listą, result odzwierciedla wartość określonych nazw lub wartości bazowych połączonych z operacją bitową OR .If value is a list, result reflects the value of the specified names or underlying values combined with a bitwise OR operation. Jeśli value jest to ciąg reprezentujący nazwę wartości wyliczenia, porównywanie value z nazwami wyliczenia jest rozróżniana wielkość liter.If value is the string representation of the name of an enumeration value, the comparison of value with enumeration names is case-sensitive.

Jeśli value jest nazwą, która nie odpowiada nazwie stałe TEnum , metoda zwraca false .If value is a name that does not correspond to a named constant of TEnum, the method returns false. Jeśli value ciąg jest reprezentacją liczby całkowitej, która nie reprezentuje bazowej wartości TEnum wyliczenia, metoda zwraca element członkowski wyliczenia, którego wartość bazowa jest value konwertowana na typ całkowity.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. Jeśli takie zachowanie jest niepożądane, wywołaj IsDefined metodę, aby upewnić się, że określony ciąg reprezentujący liczbę całkowitą jest w rzeczywistości członkiem 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.

Zobacz też

Dotyczy