Enum.ToString メソッド

定義

名前空間:

System

アセンブリ:

System.Runtime.dll

このインスタンスの値を、それと等価の文字列形式に変換します。

オーバーロード

ToString(String, IFormatProvider)	古い. このメソッドのオーバーロードは現在使用しません。代わりに ToString(String) を使用します。
ToString()	このインスタンスの値を、それと等価の文字列形式に変換します。
ToString(String)	指定した書式を使用して、このインスタンスの値をそれと等価な文字列形式に変換します。
ToString(IFormatProvider)	古い. このメソッドのオーバーロードは現在使用しません。代わりに ToString() を使用します。

ToString(String, IFormatProvider)

ソース:

Enum.cs

注意事項

The provider argument is not used. Use ToString(String) instead.

このメソッドのオーバーロードは現在使用しません。代わりに ToString(String) を使用します。

public:
 virtual System::String ^ ToString(System::String ^ format, IFormatProvider ^ provider);

[System.Obsolete("The provider argument is not used. Use ToString(String) instead.")]
public string ToString (string? format, IFormatProvider? provider);

[<System.Obsolete("The provider argument is not used. Use ToString(String) instead.")>]
override this.ToString : string * IFormatProvider -> string

Public Function ToString (format As String, provider As IFormatProvider) As String

パラメーター

format

String

書式指定。

provider

IFormatProvider

(互換性のために残されています)

戻り値

String

format で指定された、このインスタンスの値の文字列形式。

実装

ToString(String, IFormatProvider)

属性

ObsoleteAttribute

例外

FormatException

format は有効な書式指定を含みません。

InvalidOperationException

format は "X" と等しいですが、列挙型が不明です。

注釈

パラメーターには format 、"G" または "g"、"D" または "d"、"X" または "x"、および "F" または "f" のいずれかの書式指定文字列を指定できます (書式指定文字列では大文字と小文字は区別されません)。 が null または空の文字列 ("") の場合formatは、一般的な書式指定子 ("G") が使用されます。 列挙書式指定文字列と列挙値の書式設定の詳細については、「 列挙書式指定文字列」を参照してください。 書式設定全般の詳細については、「書式の 種類」を参照してください。

formatのみを指定します。providerパラメーターは互換性のために残されています。

こちらもご覧ください

• Format(Type, Object, String)
• .NET での型の書式設定
• Enumeration Format Strings

ToString()

ソース:

Enum.cs

このインスタンスの値を、それと等価の文字列形式に変換します。

public:
 override System::String ^ ToString();

public override string ToString ();

override this.ToString : unit -> string

Public Overrides Function ToString () As String

戻り値

String

このインスタンスの値の文字列形式。

例

次の例では、列挙値を文字列に変換する方法を示します。

using namespace System;
public ref class EnumSample
{
public:
   enum class Colors
   {
      Red = 1,
      Blue = 2
   };

   static void main()
   {
      Enum ^ myColors = Colors::Red;
      Console::WriteLine( "The value of this instance is '{0}'", myColors );
   }

};

int main()
{
   EnumSample::main();
}

/*
Output.
The value of this instance is 'Red'.
*/

using System;

public class EnumSample {
    enum Colors {Red = 1, Blue = 2};

    public static void Main() {
        Enum myColors = Colors.Red;
        Console.WriteLine("The value of this instance is '{0}'",
           myColors.ToString());
    }
}
/*
Output.
The value of this instance is 'Red'.
*/

type Colors =
    | Red = 1
    | Blue = 2

let myColors = Colors.Red
printfn $"The value of this instance is '{myColors.ToString()}'"

// Output.
// The value of this instance is 'Red'.

Public Class EnumSample    
    Enum Colors
        Red = 1
        Blue = 2
    End Enum
    
    Public Shared Sub Main()
        Dim myColors As Colors = Colors.Red
        Console.WriteLine("The value of this instance is '{0}'", _
           myColors.ToString())
    End Sub
End Class

'Output.
'The value of this instance is 'Red'.

注釈

戻り値は、一般的な書式指定子 ("G") で書式設定されます。 つまり、FlagsAttributeがこの列挙型に適用されず、このインスタンスの値と等しい名前付き定数がある場合、戻り値は定数の名前を含む文字列になります。 FlagsAttributeが適用され、このインスタンスの値と等しい 1 つ以上の名前付き定数の組み合わせがある場合、戻り値は定数の名前の区切り記号で区切られたリストを含む文字列になります。 それ以外の場合、戻り値は、このインスタンスの数値の文字列表現です。 列挙値の書式設定の詳細については、「 列挙書式指定文字列」を参照してください。 書式設定全般の詳細については、「書式の 種類」を参照してください。

注意 (呼び出し元)

複数の列挙メンバーが同じ基になる値を持ち、その基になる値に基づいて列挙メンバーの名前の文字列表現を取得しようとすると、コードはメソッドが返す名前を想定しないでください。 たとえば、次の列挙では、 Shade.Gray 基になる値が同じ 2 つのメンバー と Shade.Greyを定義しています。

enum Shade
{
    White = 0, Gray = 1, Grey = 1, Black = 2
}

type Shade =
    | White = 0
    | Gray = 1
    | Grey = 1
    | Black = 2

Public Enum Shade
   White = 0
   Gray = 1
   Grey = 1
   Black = 2
End Enum

次のメソッド呼び出しでは、基になる値が 1 である列挙体のメンバーの Shade 名前を取得しようとします。 メソッドは、"Gray" または "Grey" を返すことができ、どの文字列が返されるかをコードで想定してはいけません。

string shadeName = ((Shade) 1).ToString();

let shadeName = (enum<Shade> 1).ToString()

Dim shadeName As String = CType(1, Shade).ToString()

こちらもご覧ください

• Format(Type, Object, String)
• Parse(Type, String)

ToString(String)

ソース:

Enum.cs

指定した書式を使用して、このインスタンスの値をそれと等価な文字列形式に変換します。

public:
 System::String ^ ToString(System::String ^ format);

public string ToString (string? format);

override this.ToString : string -> string

Public Function ToString (format As String) As String

パラメーター

format

String

書式指定文字列。

戻り値

String

format で指定された、このインスタンスの値の文字列形式。

例外

FormatException

format に正しくない仕様が含まれています。

InvalidOperationException

format は "X" と等しいですが、列挙型が不明です。

例

次の例では、列挙値を文字列に変換する方法を示します。

// Sample for Enum::ToString(String)

using namespace System;

public enum class Colors
{
   Red, Green, Blue, Yellow = 12
};

int main()
{
   Colors myColor = Colors::Yellow;
   Console::WriteLine( "Colors::Red = {0}", Colors::Red.ToString( "d" ) );
   Console::WriteLine( "Colors::Green = {0}", Colors::Green.ToString( "d" ) );
   Console::WriteLine( "Colors::Blue = {0}", Colors::Blue.ToString( "d" ) );
   Console::WriteLine( "Colors::Yellow = {0}", Colors::Yellow.ToString( "d" ) );
   Console::WriteLine( " {0}myColor = Colors::Yellow {0}", Environment::NewLine );
   Console::WriteLine( "myColor->ToString(\"g\") = {0}", myColor.ToString( "g" ) );
   Console::WriteLine( "myColor->ToString(\"G\") = {0}", myColor.ToString( "G" ) );
   Console::WriteLine( "myColor->ToString(\"x\") = {0}", myColor.ToString( "x" ) );
   Console::WriteLine( "myColor->ToString(\"X\") = {0}", myColor.ToString( "X" ) );
   Console::WriteLine( "myColor->ToString(\"d\") = {0}", myColor.ToString( "d" ) );
   Console::WriteLine( "myColor->ToString(\"D\") = {0}", myColor.ToString( "D" ) );
   Console::WriteLine( "myColor->ToString(\"f\") = {0}", myColor.ToString( "f" ) );
   Console::WriteLine( "myColor->ToString(\"F\") = {0}", myColor.ToString( "F" ) );
}

/*
This example produces the following results:
Colors::Red = 0
Colors::Green = 1
Colors::Blue = 2
Colors::Yellow = 12

myColor = Colors::Yellow

myColor->ToString("g") = Yellow
myColor->ToString("G") = Yellow
myColor->ToString("x") = 0000000C
myColor->ToString("X") = 0000000C
myColor->ToString("d") = 12
myColor->ToString("D") = 12
myColor->ToString("f") = Yellow
myColor->ToString("F") = Yellow
*/

// Sample for Enum.ToString(String)
using System;

class Sample
{
    enum Colors {Red, Green, Blue, Yellow = 12};

    public static void Main()
    {
    Colors myColor = Colors.Yellow;

    Console.WriteLine("Colors.Red = {0}", Colors.Red.ToString("d"));
    Console.WriteLine("Colors.Green = {0}", Colors.Green.ToString("d"));
    Console.WriteLine("Colors.Blue = {0}", Colors.Blue.ToString("d"));
    Console.WriteLine("Colors.Yellow = {0}", Colors.Yellow.ToString("d"));

    Console.WriteLine("{0}myColor = Colors.Yellow{0}", Environment.NewLine);

    Console.WriteLine("myColor.ToString(\"g\") = {0}", myColor.ToString("g"));
    Console.WriteLine("myColor.ToString(\"G\") = {0}", myColor.ToString("G"));

    Console.WriteLine("myColor.ToString(\"x\") = {0}", myColor.ToString("x"));
    Console.WriteLine("myColor.ToString(\"X\") = {0}", myColor.ToString("X"));

    Console.WriteLine("myColor.ToString(\"d\") = {0}", myColor.ToString("d"));
    Console.WriteLine("myColor.ToString(\"D\") = {0}", myColor.ToString("D"));

    Console.WriteLine("myColor.ToString(\"f\") = {0}", myColor.ToString("f"));
    Console.WriteLine("myColor.ToString(\"F\") = {0}", myColor.ToString("F"));
    }
}
/*
This example produces the following results:
Colors.Red = 0
Colors.Green = 1
Colors.Blue = 2
Colors.Yellow = 12

myColor = Colors.Yellow

myColor.ToString("g") = Yellow
myColor.ToString("G") = Yellow
myColor.ToString("x") = 0000000C
myColor.ToString("X") = 0000000C
myColor.ToString("d") = 12
myColor.ToString("D") = 12
myColor.ToString("f") = Yellow
myColor.ToString("F") = Yellow
*/

// Sample for Enum.ToString(String)
open System

type Colors =
    | Red = 0 
    | Green = 1 
    | Blue = 2 
    | Yellow = 12

let myColor = Colors.Yellow

printfn $"""Colors.Red = {Colors.Red.ToString "d"}"""
printfn $"""Colors.Green = {Colors.Green.ToString "d"}"""
printfn $"""Colors.Blue = {Colors.Blue.ToString "d"}"""
printfn $"""Colors.Yellow = {Colors.Yellow.ToString "d"}"""

printfn "\nmyColor = Colors.Yellow\n"

printfn $"""myColor.ToString("g") = {myColor.ToString "g"}"""
printfn $"""myColor.ToString("G") = {myColor.ToString "G"}"""

printfn $"""myColor.ToString("x") = {myColor.ToString "x"}"""
printfn $"""myColor.ToString("X") = {myColor.ToString "X"}"""

printfn $"""myColor.ToString("d") = {myColor.ToString "d"}"""
printfn $"""myColor.ToString("D") = {myColor.ToString "d"}"""

printfn $"""myColor.ToString("f") = {myColor.ToString "f"}"""
printfn $"""myColor.ToString("F") = {myColor.ToString "F"}"""

// This example produces the following results:
//     Colors.Red = 0
//     Colors.Green = 1
//     Colors.Blue = 2
//     Colors.Yellow = 12
//    
//     myColor = Colors.Yellow
//    
//     myColor.ToString("g") = Yellow
//     myColor.ToString("G") = Yellow
//     myColor.ToString("x") = 0000000C
//     myColor.ToString("X") = 0000000C
//     myColor.ToString "d" = 12
//     myColor.ToString "d" = 12
//     myColor.ToString("f") = Yellow
//     myColor.ToString("F") = Yellow

' Sample for Enum.ToString(String)
Class Sample
   Enum Colors
      Red
      Green
      Blue
      Yellow = 12
   End Enum 'Colors
   
   Public Shared Sub Main()
      Dim myColor As Colors = Colors.Yellow
      
      Console.WriteLine("Colors.Red = {0}", Colors.Red.ToString("d"))
      Console.WriteLine("Colors.Green = {0}", Colors.Green.ToString("d"))
      Console.WriteLine("Colors.Blue = {0}", Colors.Blue.ToString("d"))
      Console.WriteLine("Colors.Yellow = {0}", Colors.Yellow.ToString("d"))
      
      Console.WriteLine("{0}myColor = Colors.Yellow{0}", Environment.NewLine)
      
      Console.WriteLine("myColor.ToString(""g"") = {0}", myColor.ToString("g"))
      Console.WriteLine("myColor.ToString(""G"") = {0}", myColor.ToString("G"))
      
      Console.WriteLine("myColor.ToString(""x"") = {0}", myColor.ToString("x"))
      Console.WriteLine("myColor.ToString(""X"") = {0}", myColor.ToString("X"))
      
      Console.WriteLine("myColor.ToString(""d"") = {0}", myColor.ToString("d"))
      Console.WriteLine("myColor.ToString(""D"") = {0}", myColor.ToString("D"))
      
      Console.WriteLine("myColor.ToString(""f"") = {0}", myColor.ToString("f"))
      Console.WriteLine("myColor.ToString(""F"") = {0}", myColor.ToString("F"))
   End Sub
End Class
'
'This example produces the following results:
'
'Colors.Red = 0
'Colors.Green = 1
'Colors.Blue = 2
'Colors.Yellow = 12
'
'myColor = Colors.Yellow
'
'myColor.ToString("g") = Yellow
'myColor.ToString("G") = Yellow
'myColor.ToString("x") = 0000000C
'myColor.ToString("X") = 0000000C
'myColor.ToString("d") = 12
'myColor.ToString("D") = 12
'myColor.ToString("f") = Yellow
'myColor.ToString("F") = Yellow
'

注釈

パラメーターには format 、"G" または "g"、"D" または "d"、"X" または "x"、および "F" または "f" のいずれかの書式指定文字列を指定できます (書式指定文字列では大文字と小文字は区別されません)。 が null または空の文字列 ("") の場合formatは、一般的な書式指定子 ("G") が使用されます。 列挙書式指定文字列と列挙値の書式設定の詳細については、「 列挙書式指定文字列」を参照してください。 書式設定全般の詳細については、「書式の 種類」を参照してください。

注意 (呼び出し元)

複数の列挙メンバーが同じ基になる値を持ち、その基になる値に基づいて列挙メンバーの名前の文字列表現を取得しようとすると、コードはメソッドが返す名前を想定しないでください。 たとえば、次の列挙では、 Shade.Gray 基になる値が同じ 2 つのメンバー と Shade.Greyを定義しています。

enum Shade
{
    White = 0, Gray = 1, Grey = 1, Black = 2
}

type Shade =
    | White = 0
    | Gray = 1
    | Grey = 1
    | Black = 2

Public Enum Shade
   White = 0
   Gray = 1
   Grey = 1
   Black = 2
End Enum

次のメソッド呼び出しでは、基になる値が 1 である列挙体のメンバーの Shade 名前を取得しようとします。 メソッドは、"Gray" または "Grey" を返すことができ、どの文字列が返されるかをコードで想定してはいけません。

string shadeName = ((Shade) 1).ToString("F");

let shadeName = (enum<Shade> 1).ToString "F"

Dim shadeName As String = CType(1, Shade).ToString("F")

こちらもご覧ください

• Format(Type, Object, String)
• Parse(Type, String)
• ToString(String, IFormatProvider)
• .NET での型の書式設定
• Enumeration Format Strings

ToString(IFormatProvider)

ソース:

Enum.cs

注意事項

The provider argument is not used. Use ToString() instead.

このメソッドのオーバーロードは現在使用しません。代わりに ToString() を使用します。

public:
 virtual System::String ^ ToString(IFormatProvider ^ provider);

[System.Obsolete("The provider argument is not used. Use ToString() instead.")]
public string ToString (IFormatProvider? provider);

[<System.Obsolete("The provider argument is not used. Use ToString() instead.")>]
override this.ToString : IFormatProvider -> string

Public Function ToString (provider As IFormatProvider) As String

パラメーター

provider

IFormatProvider

(互換性のために残されています)

戻り値

String

このインスタンスの値の文字列形式。

実装

ToString(IFormatProvider)

属性

ObsoleteAttribute