Enum.TryParse Enum.TryParse Enum.TryParse Enum.TryParse Method

定義

文字列形式での 1 つ以上の列挙定数の名前または数値を、等価の列挙オブジェクトに変換します。Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. 戻り値は、変換が成功したかどうかを示します。The return value indicates whether the conversion succeeded.

オーバーロード

TryParse(Type, String, Boolean, Object) TryParse(Type, String, Boolean, Object) TryParse(Type, String, Boolean, Object) TryParse(Type, String, Boolean, Object)
TryParse(Type, String, Object) TryParse(Type, String, Object) TryParse(Type, String, Object) TryParse(Type, String, Object)
TryParse<TEnum>(String, Boolean, TEnum) TryParse<TEnum>(String, Boolean, TEnum) TryParse<TEnum>(String, Boolean, TEnum) TryParse<TEnum>(String, Boolean, TEnum)

文字列形式での 1 つ以上の列挙定数の名前または数値を、等価の列挙オブジェクトに変換します。Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. 演算で大文字と小文字を区別するかどうかをパラメーターで指定します。A parameter specifies whether the operation is case-sensitive. 戻り値は、変換が成功したかどうかを示します。The return value indicates whether the conversion succeeded.

TryParse<TEnum>(String, TEnum) TryParse<TEnum>(String, TEnum) TryParse<TEnum>(String, TEnum) TryParse<TEnum>(String, TEnum)

文字列形式での 1 つ以上の列挙定数の名前または数値を、等価の列挙オブジェクトに変換します。Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. 戻り値は、変換が成功したかどうかを示します。The return value indicates whether the conversion succeeded.

TryParse(Type, String, Boolean, Object) TryParse(Type, String, Boolean, Object) TryParse(Type, String, Boolean, Object) TryParse(Type, String, Boolean, 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);
static member TryParse : Type * string * bool *  -> bool
Public Shared Function TryParse (enumType As Type, value As String, ignoreCase As Boolean, ByRef result As Object) As Boolean

パラメーター

enumType
Type Type Type Type

戻り値

TryParse(Type, String, Object) TryParse(Type, String, Object) TryParse(Type, String, Object) TryParse(Type, String, 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);
static member TryParse : Type * string *  -> bool
Public Shared Function TryParse (enumType As Type, value As String, ByRef result As Object) As Boolean

パラメーター

enumType
Type Type Type Type

戻り値

TryParse<TEnum>(String, Boolean, TEnum) TryParse<TEnum>(String, Boolean, TEnum) TryParse<TEnum>(String, Boolean, TEnum) TryParse<TEnum>(String, Boolean, TEnum)

文字列形式での 1 つ以上の列挙定数の名前または数値を、等価の列挙オブジェクトに変換します。Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. 演算で大文字と小文字を区別するかどうかをパラメーターで指定します。A parameter specifies whether the operation is case-sensitive. 戻り値は、変換が成功したかどうかを示します。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;
static member TryParse : string * bool *  -> bool (requires 'Enum : struct)
Public Shared Function TryParse(Of TEnum As Structure) (value As String, ignoreCase As Boolean, ByRef result As TEnum) As Boolean

型パラメーター

TEnum

value の変換先の列挙型。The enumeration type to which to convert value.

パラメーター

value
String String String String

変換する列挙定数の名前または基になる値の文字列形式。The string representation of the enumeration name or underlying value to convert.

ignoreCase
Boolean Boolean Boolean Boolean

大文字と小文字を区別しない場合は true。大文字と小文字を区別する場合は falsetrue to ignore case; false to consider case.

result
TEnum TEnum TEnum TEnum

このメソッドから制御が戻るときに、result には、解析操作が成功したときに値が TEnum で表される value 型のオブジェクトが格納されます。When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. 解析操作が失敗した場合、result には TEnum の基になる型の既定値が格納されます。If the parse operation fails, result contains the default value of the underlying type of TEnum. この値が TEnum 列挙型のメンバーである必要がないことに注意してください。Note that this value need not be a member of the TEnum enumeration. このパラメーターは初期化せずに渡されます。This parameter is passed uninitialized.

戻り値

value パラメーターが正常に変換された場合は true。それ以外の場合は falsetrue if the value parameter was converted successfully; otherwise, false.

例外

TEnum は列挙型ではありません。TEnum is not an enumeration type.

次の例では、定義、Colors列挙型、呼び出し、TryParse<TEnum>(String, Boolean, TEnum)メソッドを呼び出し、対応する列挙値を文字列に変換する、IsDefinedで値を特定の整数値が基になることを確認する方法Colors列挙体。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)を等価の列挙値に定数をという名前の文字列形式を変換しようとするときに、メソッドが大文字と小文字を使用します。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.

注釈

TryParse<TEnum>(String, Boolean, TEnum) 同じですが、Parse(Type, String, Boolean)メソッドが返されます、例外をスローする代わりにfalse変換が失敗した場合。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. 例外処理する列挙値の文字列表現を解析するときの必要はありません。It eliminates the need for exception handling when parsing the string representation of an enumeration value.

valueパラメーターには、列挙体のメンバーの基になる値または名前付き定数の文字列表現が含まれているか、名前付き定数または基になる値の一覧がコンマ (,) で区切られます。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 (,). 場合valueが複数には含まれてという名前の定数または値を 1 つ以上の空白の前にしたり、以下の各値、名、またはコンマで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. 場合valueリスト、 result 、指定した名前の値を反映または演算と組み合わせる値を基になるOR操作。If value is a list, result reflects the value of the specified names or underlying values combined with a bitwise OR operation. 場合valueの比較、列挙値の名前の文字列表現ですvalue列挙型名によって異なります、ignoreCaseパラメーター。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. 場合true、大文字と小文字の比較は場合falseは大文字小文字を区別します。If true, the comparison is case-insensitive; if false, it is case-sensitive.

場合valueの名前付き定数に対応していない名前は、 TEnum、メソッドを返しますfalseします。If value is a name that does not correspond to a named constant of TEnum, the method returns false. 場合valueの基になる値を表していない整数の文字列表現です、TEnum列挙型、メソッドは基になる値が列挙体のメンバーを返しますvalue整数型に変換します。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. この動作が望ましくない場合は、呼び出し、 IsDefined 、整数の特定の文字列表現が実際のメンバーであることを確認するメソッド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.

こちらもご覧ください

TryParse<TEnum>(String, TEnum) TryParse<TEnum>(String, TEnum) TryParse<TEnum>(String, TEnum) TryParse<TEnum>(String, TEnum)

文字列形式での 1 つ以上の列挙定数の名前または数値を、等価の列挙オブジェクトに変換します。Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. 戻り値は、変換が成功したかどうかを示します。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;
static member TryParse : string *  -> bool (requires 'Enum : struct)
Public Shared Function TryParse(Of TEnum As Structure) (value As String, ByRef result As TEnum) As Boolean

型パラメーター

TEnum

value の変換先の列挙型。The enumeration type to which to convert value.

パラメーター

value
String String String String

変換する列挙定数の名前または基になる値の文字列形式。大文字と小文字が区別されます。The case-sensitive string representation of the enumeration name or underlying value to convert.

result
TEnum TEnum TEnum TEnum

このメソッドから制御が戻るときに、result には、解析操作が成功したときに値が TEnum で表される value 型のオブジェクトが格納されます。When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. 解析操作が失敗した場合、result には TEnum の基になる型の既定値が格納されます。If the parse operation fails, result contains the default value of the underlying type of TEnum. この値が TEnum 列挙型のメンバーである必要がないことに注意してください。Note that this value need not be a member of the TEnum enumeration. このパラメーターは初期化せずに渡されます。This parameter is passed uninitialized.

戻り値

value パラメーターが正常に変換された場合は true。それ以外の場合は falsetrue if the value parameter was converted successfully; otherwise, false.

例外

TEnum は列挙型ではありません。TEnum is not an enumeration type.

次の例では、定義、Colors列挙型、呼び出し、TryParse<TEnum>(String, TEnum)メソッドを呼び出し、対応する列挙値を文字列に変換する、IsDefinedで値を特定の整数値が基になることを確認する方法Colors列挙体。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.

注釈

TryParse<TEnum>(String, TEnum) 同じですが、Parse(Type, String)メソッドが返されます、例外をスローする代わりにfalse変換が失敗した場合。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. 例外処理する列挙値の文字列表現を解析するときの必要はありません。It eliminates the need for exception handling when parsing the string representation of an enumeration value.

valueパラメーターには、列挙体のメンバーの基になる値または名前付き定数の文字列表現が含まれているか、名前付き定数または基になる値の一覧がコンマ (,) で区切られます。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 (,). 場合valueが複数には含まれてという名前の定数または値を 1 つ以上の空白の前にしたり、以下の各値、名、またはコンマで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. 場合valueリスト、 result 、指定した名前の値を反映または演算と組み合わせる値を基になるOR操作。If value is a list, result reflects the value of the specified names or underlying values combined with a bitwise OR operation. 場合valueの比較、列挙値の名前の文字列表現ですvalue列挙型名は大文字小文字を区別します。If value is the string representation of the name of an enumeration value, the comparison of value with enumeration names is case-sensitive.

場合valueの名前付き定数に対応していない名前は、 TEnum、メソッドを返しますfalseします。If value is a name that does not correspond to a named constant of TEnum, the method returns false. 場合valueの基になる値を表していない整数の文字列表現です、TEnum列挙型、メソッドは基になる値が列挙体のメンバーを返しますvalue整数型に変換します。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. この動作が望ましくない場合は、呼び出し、 IsDefined 、整数の特定の文字列表現が実際のメンバーであることを確認するメソッド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.

こちらもご覧ください

適用対象