Enum.TryParse Metoda

Definice

Obor názvů:

System

Sestavení:

System.Runtime.dll

Převede řetězcovou reprezentaci názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt. Vrácená hodnota označuje, jestli byl převod úspěšný.

Přetížení

TryParse(Type, ReadOnlySpan<Char>, Object)	Převede rozsah znaků reprezentace názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt.
TryParse(Type, String, Object)	Převede řetězcovou reprezentaci názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt.
TryParse(Type, ReadOnlySpan<Char>, Boolean, Object)	Převede rozsah znaků reprezentace názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt. Parametr určuje, zda je operace nerozlišována malá a velká písmena.
TryParse(Type, String, Boolean, Object)	Převede řetězcovou reprezentaci názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt.
TryParse<TEnum>(ReadOnlySpan<Char>, TEnum)	Převede řetězcovou reprezentaci názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt.
TryParse<TEnum>(String, TEnum)	Převede řetězcovou reprezentaci názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt. Vrácená hodnota označuje, jestli byl převod úspěšný.
TryParse<TEnum>(String, Boolean, TEnum)	Převede řetězcovou reprezentaci názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt. Parametr určuje, jestli je operace citlivá na malá a velká písmena. Vrácená hodnota označuje, jestli byl převod úspěšný.
TryParse<TEnum>(ReadOnlySpan<Char>, Boolean, TEnum)	Převede řetězcovou reprezentaci názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt. Parametr určuje, jestli je operace citlivá na malá a velká písmena. Vrácená hodnota označuje, jestli byl převod úspěšný.

TryParse(Type, ReadOnlySpan<Char>, Object)

Zdroj:

Enum.cs

Převede rozsah znaků reprezentace názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt.

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

Parametry

enumType

Type

Typ výčtu, který se má použít k analýze.

value

ReadOnlySpan<Char>

Reprezentace názvu nebo číselné hodnoty jedné nebo více výčtových konstant.

result

Object

Když tato metoda vrátí true, obsahuje výčet konstanta, která představuje parsovanou hodnotu.

Návraty

Boolean

true, pokud byl převod úspěšný; false jinak.

Výjimky

InvalidOperationException

.NET 8 a novější verze: enumType je logický typ výčtu.

TryParse(Type, String, Object)

Zdroj:

Enum.cs

Převede řetězcovou reprezentaci názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt.

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

Parametry

enumType

Type

Typ výčtu, který se má použít k analýze.

value

String

Řetězcové vyjádření názvu nebo číselné hodnoty jedné nebo více výčtových konstant.

result

Object

Když tato metoda vrátí true, obsahuje výčet konstanta, která představuje parsovanou hodnotu.

Návraty

Boolean

true, pokud byl převod úspěšný; false jinak.

Výjimky

InvalidOperationException

.NET 8 a novější verze: enumType je logický typ výčtu.

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

Zdroj:

Enum.cs

Převede rozsah znaků reprezentace názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt. Parametr určuje, zda je operace nerozlišována malá a velká písmena.

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

Parametry

enumType

Type

Typ výčtu, který se má použít k analýze.

value

ReadOnlySpan<Char>

Reprezentace názvu nebo číselné hodnoty jedné nebo více výčtových konstant.

ignoreCase

Boolean

true číst enumType v režimu bez rozlišování malých a malých písmen; false čtení enumType v režimu rozlišování velkých a malých písmen.

result

Object

Když tato metoda vrátí true, obsahuje výčet konstanta, která představuje parsovanou hodnotu.

Návraty

Boolean

true, pokud byl převod úspěšný; false jinak.

Výjimky

InvalidOperationException

.NET 8 a novější verze: enumType je logický typ výčtu.

TryParse(Type, String, Boolean, Object)

Zdroj:

Enum.cs

Převede řetězcovou reprezentaci názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt.

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

Parametry

enumType

Type

Typ výčtu, který se má použít k analýze.

value

String

Řetězcové vyjádření názvu nebo číselné hodnoty jedné nebo více výčtových konstant.

ignoreCase

Boolean

true číst value v režimu bez rozlišování malých a malých písmen; false čtení value v režimu rozlišování velkých a malých písmen.

result

Object

Když tato metoda vrátí true, obsahuje výčet konstanta, která představuje parsovanou hodnotu.

Návraty

Boolean

true, pokud byl převod úspěšný; false jinak.

Výjimky

InvalidOperationException

.NET 8 a novější verze: enumType je logický typ výčtu.

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

Zdroj:

Enum.cs

Převede řetězcovou reprezentaci názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt.

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

Parametry typu

TEnum

Typ objektu result.

Parametry

value

ReadOnlySpan<Char>

Reprezentace názvu nebo číselné hodnoty jedné nebo více výčtových konstant.

result

TEnum

Když tato metoda vrátí true, obsahuje výčet konstanta, která představuje parsovanou hodnotu.

Návraty

Boolean

true, pokud byl převod úspěšný; false jinak.

Výjimky

ArgumentException

TEnum není typ výčtu.

InvalidOperationException

.NET 8 a novější verze: TEnum je logický typ výčtu.

TryParse<TEnum>(String, TEnum)

Zdroj:

Enum.cs

Převede řetězcovou reprezentaci názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt. Vrácená hodnota označuje, jestli byl převod úspěšný.

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

Parametry typu

TEnum

Typ výčtu, na který chcete převést value.

Parametry

value

String

Řetězcová reprezentace názvu výčtu nebo podkladové hodnoty, která se má převést, rozlišují velká a malá písmena.

result

TEnum

Pokud tato metoda vrátí, obsahuje objekt typu TEnum jehož hodnota je reprezentována value pokud operace analýzy proběhne úspěšně. Pokud operace analýzy selže, obsahuje výchozí hodnotu základního typu TEnum. Tento parametr se předává neinicializovaný.

Návraty

Boolean

true, pokud byl parametr value úspěšně převeden; jinak false.

Výjimky

ArgumentException

TEnum není typ výčtu.

InvalidOperationException

.NET 8 a novější verze: TEnum je logický typ výčtu.

Příklady

Následující příklad definuje Colors výčtu, volá metodu TryParse<TEnum>(String, TEnum) pro převod řetězců na odpovídající hodnoty výčtu a volá metodu IsDefined, aby se zajistilo, že konkrétní celočíselné hodnoty jsou podkladové hodnoty v Colors výčtu.

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.

Poznámky

TryParse<TEnum>(String, TEnum) je shodná s metodou Parse(Type, String) s tím rozdílem, že místo vyvolání výjimky vrátí false, pokud převod selže. Eliminuje potřebu zpracování výjimek při analýze řetězcové reprezentace hodnoty výčtu.

Parametr value obsahuje řetězcovou reprezentaci základní hodnoty nebo pojmenované konstanty člena výčtu nebo seznam pojmenovaných konstant nebo podkladových hodnot oddělených čárkami (,). Pokud value obsahuje více pojmenovaných konstant nebo hodnot, může jedna nebo více prázdných mezer předcházet každé hodnotě, názvu nebo čárkám v value. Pokud value je seznam, result odráží hodnotu zadaných názvů nebo podkladových hodnot v kombinaci s bitovým OR operací. Pokud value je řetězcová reprezentace názvu hodnoty výčtu, porovnání value s názvy výčtů rozlišují malá a velká písmena.

Pokud value je název, který neodpovídá pojmenované konstantě TEnum, metoda vrátí false. Pokud value je řetězcové vyjádření celého čísla, které nepředstavuje podkladovou hodnotu TEnum výčtu, vrátí metoda člen výčtu, jehož základní hodnota je value převedena na celočíselný typ. Pokud je toto chování nežádoucí, zavolejte metodu IsDefined, aby se zajistilo, že určité řetězcové vyjádření celého čísla je ve skutečnosti členem TEnum.

Pokud operace analýzy selže, parametr result obsahuje výchozí hodnotu 0, která nemusí být členem podkladového TEnum výčtu. Pokud nejsou k pojmenovaným konstantám v TEnumpřiřazeny žádné hodnoty, je výchozí hodnota rovna prvnímu členu TEnum. V opačném případě se výchozí hodnota rovná členu v výčtu s přiřazenou hodnotou 0.

Viz také

• Parse(Type, String)

TryParse<TEnum>(String, Boolean, TEnum)

Zdroj:

Enum.cs

Převede řetězcovou reprezentaci názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt. Parametr určuje, jestli je operace citlivá na malá a velká písmena. Vrácená hodnota označuje, jestli byl převod úspěšný.

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

Parametry typu

TEnum

Typ výčtu, na který chcete převést value.

Parametry

value

String

Řetězcová reprezentace názvu výčtu nebo podkladové hodnoty, která se má převést.

ignoreCase

Boolean

true ignorovat případ; false zvážit případ.

result

TEnum

Pokud tato metoda vrátí, obsahuje objekt typu TEnum jehož hodnota je reprezentována value pokud operace analýzy proběhne úspěšně. Pokud operace analýzy selže, obsahuje výchozí hodnotu základního typu TEnum. Tento parametr se předává neinicializovaný.

Návraty

Boolean

true, pokud byl parametr value úspěšně převeden; jinak false.

Výjimky

ArgumentException

TEnum není typ výčtu.

InvalidOperationException

.NET 8 a novější verze: TEnum je logický typ výčtu.

Příklady

Následující příklad definuje Colors výčtu, volá metodu TryParse<TEnum>(String, Boolean, TEnum) pro převod řetězců na odpovídající hodnoty výčtu a volá metodu IsDefined, aby se zajistilo, že konkrétní celočíselné hodnoty jsou podkladové hodnoty v Colors výčtu. Metoda TryParse<TEnum>(String, Boolean, TEnum) při pokusu o převod řetězcových reprezentací pojmenovaných konstant na ekvivalentní hodnoty výčtu používá porovnání nerozlišující velká a malá písmena.

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.

Poznámky

TryParse<TEnum>(String, Boolean, TEnum) je shodná s metodou Parse(Type, String, Boolean) s tím rozdílem, že místo vyvolání výjimky vrátí false, pokud převod selže. Eliminuje potřebu zpracování výjimek při analýze řetězcové reprezentace hodnoty výčtu.

Parametr value obsahuje řetězcovou reprezentaci základní hodnoty nebo pojmenované konstanty člena výčtu nebo seznam pojmenovaných konstant nebo podkladových hodnot oddělených čárkami (,). Pokud value obsahuje více pojmenovaných konstant nebo hodnot, může jedna nebo více prázdných mezer předcházet každé hodnotě, názvu nebo čárkám v value. Pokud value je seznam, result odráží hodnotu zadaných názvů nebo podkladových hodnot v kombinaci s bitovým OR operací. Pokud value je řetězcová reprezentace názvu hodnoty výčtu, porovnání value s názvy výčtů závisí na parametru ignoreCase. Pokud true, porovnání nerozlišuje malá a velká písmena; pokud false, rozlišují se malá a velká písmena.

Pokud value je název, který neodpovídá pojmenované konstantě TEnum, metoda vrátí false. Pokud value je řetězcové vyjádření celého čísla, které nepředstavuje podkladovou hodnotu TEnum výčtu, vrátí metoda člen výčtu, jehož základní hodnota je value převedena na celočíselný typ. Pokud je toto chování nežádoucí, zavolejte metodu IsDefined, aby se zajistilo, že určité řetězcové vyjádření celého čísla je ve skutečnosti členem TEnum.

Pokud operace analýzy selže, parametr result obsahuje výchozí hodnotu 0, která nemusí být členem podkladového TEnum výčtu. Pokud nejsou k pojmenovaným konstantám v TEnumpřiřazeny žádné hodnoty, je výchozí hodnota rovna prvnímu členu TEnum. V opačném případě se výchozí hodnota rovná členu v výčtu s přiřazenou hodnotou 0.

Viz také

• Parse(Type, String, Boolean)

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

Zdroj:

Enum.cs

Převede řetězcovou reprezentaci názvu nebo číselné hodnoty jedné nebo více výčtových konstant na ekvivalentní výčtový objekt. Parametr určuje, jestli je operace citlivá na malá a velká písmena. Vrácená hodnota označuje, jestli byl převod úspěšný.

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

Parametry typu

TEnum

Typ objektu result.

Parametry

value

ReadOnlySpan<Char>

Reprezentace názvu nebo číselné hodnoty jedné nebo více výčtových konstant.

ignoreCase

Boolean

true ignorovat případ; false zvážit případ.

result

TEnum

Když tato metoda vrátí true, obsahuje výčet konstanta, která představuje parsovanou hodnotu.

Návraty

Boolean

true, pokud byl převod úspěšný; false jinak.

Výjimky

ArgumentException

TEnum není typ výčtu.

InvalidOperationException

.NET 8 a novější verze: TEnum je logický typ výčtu.