Enum.ToString Enum.ToString Enum.ToString Enum.ToString Method

定義

このインスタンスの値を、それと等価の文字列形式に変換します。Converts the value of this instance to its equivalent string representation.

オーバーロード

ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider)

このメソッドのオーバーロードは現在使用しません。代わりに ToString(String) を使用します。This method overload is obsolete; use ToString(String).

ToString(String) ToString(String) ToString(String) ToString(String)

指定した書式を使用して、このインスタンスの値をそれと等価な文字列形式に変換します。Converts the value of this instance to its equivalent string representation using the specified format.

ToString(IFormatProvider) ToString(IFormatProvider) ToString(IFormatProvider) ToString(IFormatProvider)

このメソッドのオーバーロードは現在使用しません。代わりに ToString() を使用します。This method overload is obsolete; use ToString().

ToString() ToString() ToString() ToString()

このインスタンスの値を、それと等価の文字列形式に変換します。Converts the value of this instance to its equivalent string representation.

ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider)

警告

この API は現在使われていません。

このメソッドのオーバーロードは現在使用しません。代わりに ToString(String) を使用します。This method overload is obsolete; use ToString(String).

public:
 virtual System::String ^ ToString(System::String ^ format, IFormatProvider ^ provider);
[System.Obsolete("The provider argument is not used. Please use ToString(String).")]
public string ToString (string format, IFormatProvider provider);
override this.ToString : string * IFormatProvider -> string
Public Function ToString (format As String, provider As IFormatProvider) As String

パラメーター

format
String String String String

書式指定。A format specification.

provider
IFormatProvider IFormatProvider IFormatProvider IFormatProvider

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

戻り値

format で指定された、このインスタンスの値の文字列形式。The string representation of the value of this instance as specified by format.

実装

例外

format は有効な書式指定を含みません。format does not contain a valid format specification.

format は "X" と等しいですが、列挙型が不明です。format equals "X", but the enumeration type is unknown.

注釈

パラメーター formatには、次のいずれかの書式指定文字列を指定できます。"G" または "g"、"D"、"d"、"X"、"x"、"F"、"f" (書式指定文字列では大文字と小文字は区別されません)。The format parameter can be one of the following format strings: "G" or "g", "D" or "d", "X" or "x", and "F" or "f" (the format string is not case-sensitive). formatnullまたは空の文字列 ("") の場合は、一般書式指定子 ("G") が使用されます。If format is null or an empty string (""), the general format specifier ("G") is used. 列挙型書式指定文字列と列挙値の書式設定の詳細については、「列挙型書式指定文字列」を参照してください。For more information about the enumeration format strings and formatting enumeration values, see Enumeration Format Strings. 一般的な書式設定の詳細については、「型の書式設定」を参照してください。For more information about formatting in general, see Formatting Types.

のみformatを指定しproviderます。パラメーターは互換性のために残されています。Specify only format; the provider parameter is obsolete.

こちらもご覧ください

ToString(String) ToString(String) ToString(String) ToString(String)

指定した書式を使用して、このインスタンスの値をそれと等価な文字列形式に変換します。Converts the value of this instance to its equivalent string representation using the specified format.

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

書式指定文字列。A format string.

戻り値

format で指定された、このインスタンスの値の文字列形式。The string representation of the value of this instance as specified by format.

例外

format に正しくない仕様が含まれています。format contains an invalid specification.

format は "X" と等しいですが、列挙型が不明です。format equals "X", but the enumeration type is unknown.

次の例は、列挙値を文字列に変換する方法を示しています。The following example demonstrates how to convert an enumerated value to a string.

// 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)
Imports System

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 'Main
End Class 'Sample
'
'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" (書式指定文字列では大文字と小文字は区別されません)。The format parameter can be one of the following format strings: "G" or "g", "D" or "d", "X" or "x", and "F" or "f" (the format string is not case-sensitive). formatnullまたは空の文字列 ("") の場合は、一般書式指定子 ("G") が使用されます。If format is null or an empty string (""), the general format specifier ("G") is used. 列挙型書式指定文字列と列挙値の書式設定の詳細については、「列挙型書式指定文字列」を参照してください。For more information about the enumeration format strings and formatting enumeration values, see Enumeration Format Strings. 一般的な書式設定の詳細については、「型の書式設定」を参照してください。For more information about formatting in general, see Formatting Types.

注意 (呼び出し元)

複数の列挙体メンバーの基になる値が同じで、その基になる値に基づいて列挙メンバーの名前の文字列形式を取得しようとする場合、コードでは、メソッドが返す名前については想定しないでください。If multiple enumeration members have the same underlying value and you attempt to retrieve the string representation of an enumeration member's name based on its underlying value, your code should not make any assumptions about which name the method will return. たとえば、次の列挙体は、同じ基になる値を持つ2つのメンバー (灰色陰影) を定義しています。For example, the following enumeration defines two members, Shade.Gray and Shade.Grey, that have the same underlying value.

[!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1][!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1] 次のメソッド呼び出しは、基になる値が1である、網掛け列挙体のメンバーの名前を取得しようとします。The following method call attempts to retrieve the name of a member of the Shade enumeration whose underlying value is 1. メソッドは、"Gray" または "Gray" を返すことができます。また、どの文字列が返されるかをコードで想定してはいけません。The method can return either "Gray" or "Grey", and your code should not make any assumptions about which string will be returned.

[!code-csharpSystem.Enum.ToString#3] [!code-vbSystem.Enum.ToString#3][!code-csharpSystem.Enum.ToString#3] [!code-vbSystem.Enum.ToString#3]

こちらもご覧ください

ToString(IFormatProvider) ToString(IFormatProvider) ToString(IFormatProvider) ToString(IFormatProvider)

警告

この API は現在使われていません。

このメソッドのオーバーロードは現在使用しません。代わりに ToString() を使用します。This method overload is obsolete; use ToString().

public:
 virtual System::String ^ ToString(IFormatProvider ^ provider);
[System.Obsolete("The provider argument is not used. Please use ToString().")]
public string ToString (IFormatProvider provider);
override this.ToString : IFormatProvider -> string
Public Function ToString (provider As IFormatProvider) As String

パラメーター

provider
IFormatProvider IFormatProvider IFormatProvider IFormatProvider

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

戻り値

このインスタンスの値の文字列形式。The string representation of the value of this instance.

実装

ToString() ToString() ToString() ToString()

このインスタンスの値を、それと等価の文字列形式に変換します。Converts the value of this instance to its equivalent string representation.

public:
 override System::String ^ ToString();
public override string ToString ();
override this.ToString : unit -> string
Public Overrides Function ToString () As String

戻り値

このインスタンスの値の文字列形式。The string representation of the value of this instance.

次の例では、列挙値を文字列に変換する方法を示します。The following example demonstrates converting an enumerated value to a 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'.
*/
Imports System

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") で書式設定されます。The return value is formatted with the general format specifier ("G"). つまり、がこの列挙FlagsAttribute型に適用されず、このインスタンスの値と等しい名前付き定数がある場合、戻り値は定数の名前を含む文字列になります。That is, if the FlagsAttribute is not applied to this enumerated type and there is a named constant equal to the value of this instance, then the return value is a string containing the name of the constant. FlagsAttributeが適用され、このインスタンスの値と等しい1つ以上の名前付き定数が組み合わされている場合、戻り値は、定数の名前の区切り記号で区切られたリストを含む文字列になります。If the FlagsAttribute is applied and there is a combination of one or more named constants equal to the value of this instance, then the return value is a string containing a delimiter-separated list of the names of the constants. それ以外の場合、戻り値は、このインスタンスの数値の文字列表現になります。Otherwise, the return value is the string representation of the numeric value of this instance. 列挙値の書式設定の詳細については、「列挙型書式指定文字列」を参照してください。For more information about formatting enumeration values, see Enumeration Format Strings. 一般的な書式設定の詳細については、「型の書式設定」を参照してください。For more information about formatting in general, see Formatting Types.

注意 (呼び出し元)

複数の列挙体メンバーの基になる値が同じで、その基になる値に基づいて列挙メンバーの名前の文字列形式を取得しようとする場合、コードでは、メソッドが返す名前については想定しないでください。If multiple enumeration members have the same underlying value and you attempt to retrieve the string representation of an enumeration member's name based on its underlying value, your code should not make any assumptions about which name the method will return. たとえば、次の列挙体は、同じ基になる値を持つ2つのメンバー (灰色陰影) を定義しています。For example, the following enumeration defines two members, Shade.Gray and Shade.Grey, that have the same underlying value.

[!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1][!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1] 次のメソッド呼び出しは、基になる値が1である、網掛け列挙体のメンバーの名前を取得しようとします。The following method call attempts to retrieve the name of a member of the Shade enumeration whose underlying value is 1. メソッドは、"Gray" または "Gray" を返すことができます。また、どの文字列が返されるかをコードで想定してはいけません。The method can return either "Gray" or "Grey", and your code should not make any assumptions about which string will be returned.

[!code-csharpSystem.Enum.ToString#2] [!code-vbSystem.Enum.ToString#2][!code-csharpSystem.Enum.ToString#2] [!code-vbSystem.Enum.ToString#2]

こちらもご覧ください

適用対象