Enum.ToString Methode

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Konvertiert den Wert dieser Instanz in die entsprechende Zeichenfolgendarstellung.

Überlädt

ToString(String, IFormatProvider)	Veraltet. Diese Methodenüberladung ist veraltet. Verwenden Sie ToString(String).
ToString()	Konvertiert den Wert dieser Instanz in die entsprechende Zeichenfolgendarstellung.
ToString(String)	Konvertiert den Wert dieser Instanz anhand des angegebenen Formats in die entsprechende Zeichenfolgendarstellung.
ToString(IFormatProvider)	Veraltet. Diese Methodenüberladung ist veraltet. Verwenden Sie ToString().

ToString(String, IFormatProvider)

Quelle:

Enum.cs

Achtung

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

Diese Methodenüberladung ist veraltet. Verwenden Sie 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

Parameter

format

String

Eine Formatangabe.

provider

IFormatProvider

(Veraltet)

Gibt zurück

String

Die Zeichenfolgendarstellung des Werts dieser Instanz entsprechend den Angaben von format.

Implementiert

ToString(String, IFormatProvider)

Attribute

ObsoleteAttribute

Ausnahmen

FormatException

format enthält keine gültige Formatangabe.

InvalidOperationException

format entspricht „X“, aber der Enumerationstyp ist unbekannt.

Hinweise

Der format Parameter kann eine der folgenden Formatzeichenfolgen sein: "G" oder "g", "D" oder "d", "X" oder "x" und "F" oder "f" (bei der Formatzeichenfolge wird die Groß-/Kleinschreibung nicht beachtet). Wenn format eine leere Zeichenfolge ("") ist null , wird der allgemeine Formatbezeichner ("G") verwendet. Weitere Informationen zu den Enumerationsformatzeichenfolgen und Formatierungsaufzählungswerten finden Sie unter Enumerationsformatzeichenfolgen. Weitere Informationen zur Formatierung im Allgemeinen finden Sie unter Formatierungstypen.

Geben Sie nur formatan. Der provider Parameter ist veraltet.

Weitere Informationen

• Format(Type, Object, String)
• Formatieren von Typen in .NET
• Enumerationsformatzeichenfolgen

ToString()

Quelle:

Enum.cs

Konvertiert den Wert dieser Instanz in die entsprechende Zeichenfolgendarstellung.

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

public override string ToString ();

override this.ToString : unit -> string

Public Overrides Function ToString () As String

Gibt zurück

String

Die Zeichenfolgendarstellung des Werts dieser Instanz.

Beispiele

Im folgenden Beispiel wird das Konvertieren eines aufgezählten Werts in eine Zeichenfolge veranschaulicht.

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'.

Hinweise

Der Rückgabewert wird mit dem allgemeinen Formatbezeichner ("G") formatiert. Das heißt, wenn der FlagsAttribute nicht auf diesen aufgezählten Typ angewendet wird und eine benannte Konstante gleich dem Wert dieser Instanz ist, ist der Rückgabewert eine Zeichenfolge, die den Namen der Konstante enthält. Wenn angewendet FlagsAttribute wird und eine Kombination aus einer oder mehreren benannten Konstanten vorhanden ist, die dem Wert dieser Instanz entsprechen, ist der Rückgabewert eine Zeichenfolge, die eine durch Trennzeichen getrennte Liste der Namen der Konstanten enthält. Andernfalls ist der Rückgabewert die Zeichenfolgendarstellung des numerischen Werts dieser Instanz. Weitere Informationen zum Formatieren von Enumerationswerten finden Sie unter Enumerationsformatzeichenfolgen. Weitere Informationen zur Formatierung im Allgemeinen finden Sie unter Formatierungstypen.

Hinweise für Aufrufer

Wenn mehrere Enumerationsmember denselben zugrunde liegenden Wert aufweisen und Sie versuchen, die Zeichenfolgendarstellung des Namens eines Enumerationsmembers basierend auf dem zugrunde liegenden Wert abzurufen, sollte Ihr Code keine Annahmen darüber treffen, welchen Namen die Methode zurückgibt. Die folgende Enumeration definiert beispielsweise zwei Member undShade.Grey, Shade.Gray die den gleichen zugrunde liegenden Wert aufweisen.

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

Mit dem folgenden Methodenaufruf wird versucht, den Namen eines Members der Shade Enumeration abzurufen, dessen zugrunde liegender Wert 1 ist. Die -Methode kann entweder "Gray" oder "Grey" zurückgeben, und Ihr Code sollte keine Annahmen darüber treffen, welche Zeichenfolge zurückgegeben wird.

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

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

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

Weitere Informationen

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

ToString(String)

Quelle:

Enum.cs

Konvertiert den Wert dieser Instanz anhand des angegebenen Formats in die entsprechende Zeichenfolgendarstellung.

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

Parameter

format

String

Eine Formatzeichenfolge.

Gibt zurück

String

Die Zeichenfolgendarstellung des Werts dieser Instanz entsprechend den Angaben von format.

Ausnahmen

FormatException

format enthält eine ungültige Angabe.

InvalidOperationException

format entspricht „X“, aber der Enumerationstyp ist unbekannt.

Beispiele

Im folgenden Beispiel wird veranschaulicht, wie ein aufgezählter Wert in eine Zeichenfolge konvertiert wird.

// 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
'

Hinweise

Der format Parameter kann eine der folgenden Formatzeichenfolgen sein: "G" oder "g", "D" oder "d", "X" oder "x" und "F" oder "f" (bei der Formatzeichenfolge wird die Groß-/Kleinschreibung nicht beachtet). Wenn format eine leere Zeichenfolge ("") ist null , wird der allgemeine Formatbezeichner ("G") verwendet. Weitere Informationen zu den Enumerationsformatzeichenfolgen und Formatierungsaufzählungswerten finden Sie unter Enumerationsformatzeichenfolgen. Weitere Informationen zur Formatierung im Allgemeinen finden Sie unter Formatierungstypen.

Hinweise für Aufrufer

Wenn mehrere Enumerationsmember denselben zugrunde liegenden Wert aufweisen und Sie versuchen, die Zeichenfolgendarstellung des Namens eines Enumerationsmembers basierend auf dem zugrunde liegenden Wert abzurufen, sollte Ihr Code keine Annahmen darüber treffen, welchen Namen die Methode zurückgibt. Die folgende Enumeration definiert beispielsweise zwei Member undShade.Grey, Shade.Gray die den gleichen zugrunde liegenden Wert aufweisen.

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

Mit dem folgenden Methodenaufruf wird versucht, den Namen eines Members der Shade Enumeration abzurufen, dessen zugrunde liegender Wert 1 ist. Die -Methode kann entweder "Gray" oder "Grey" zurückgeben, und Ihr Code sollte keine Annahmen darüber treffen, welche Zeichenfolge zurückgegeben wird.

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

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

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

Weitere Informationen

• Format(Type, Object, String)
• Parse(Type, String)
• ToString(String, IFormatProvider)
• Formatieren von Typen in .NET
• Enumerationsformatzeichenfolgen

ToString(IFormatProvider)

Quelle:

Enum.cs

Achtung

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

Diese Methodenüberladung ist veraltet. Verwenden Sie 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

Parameter

provider

IFormatProvider

(Veraltet)

Gibt zurück

String

Die Zeichenfolgendarstellung des Werts dieser Instanz.

Implementiert

ToString(IFormatProvider)

Attribute

ObsoleteAttribute