Enum.ToString Metoda

Definicja

Przestrzeń nazw:

System

Zestaw:

System.Runtime.dll

Konwertuje wartość tego wystąpienia na jego równoważną reprezentację w postaci ciągu.

Przeciążenia

ToString(String, IFormatProvider)	Przestarzałe. To przeciążenie metody jest przestarzałe; użyj polecenia ToString(String).
ToString()	Konwertuje wartość tego wystąpienia na jego równoważną reprezentację w postaci ciągu.
ToString(String)	Konwertuje wartość tego wystąpienia na równoważną reprezentację ciągu przy użyciu określonego formatu.
ToString(IFormatProvider)	Przestarzałe. To przeciążenie metody jest przestarzałe; użyj polecenia ToString().

ToString(String, IFormatProvider)

Źródło:

Enum.cs

Przestroga

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

To przeciążenie metody jest przestarzałe; użyj polecenia 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

Parametry

format

String

Specyfikacja formatu.

provider

IFormatProvider

(Przestarzałe).

Zwraca

String

Ciąg reprezentacja wartości tego wystąpienia określona przez format.

Implementuje

ToString(String, IFormatProvider)

Atrybuty

ObsoleteAttribute

Wyjątki

FormatException

format nie zawiera prawidłowej specyfikacji formatu.

InvalidOperationException

format równa się "X", ale typ wyliczenia jest nieznany.

Uwagi

Parametr format może być jednym z następujących ciągów formatu: "G" lub "g", "D" lub "d", "X" lub "x" oraz "F" lub "f" (ciąg formatu nie uwzględnia wielkości liter). Jeśli format jest null lub ciąg pusty (""), jest używany ogólny specyfikator formatu ("G"). Aby uzyskać więcej informacji na temat ciągów formatu wyliczenia i wartości wyliczenia formatowania, zobacz Ciągi formatu wyliczenia. Aby uzyskać więcej informacji na temat formatowania ogólnie, zobacz Typy formatowania.

Określ tylko formatparametr ; provider parametr jest przestarzały.

Zobacz też

• Format(Type, Object, String)
• Typy formatowania na platformie .NET
• Ciągi formatu wyliczenia

ToString()

Źródło:

Enum.cs

Konwertuje wartość tego wystąpienia na jego równoważną reprezentację w postaci ciągu.

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

public override string ToString ();

override this.ToString : unit -> string

Public Overrides Function ToString () As String

Zwraca

String

Ciąg reprezentujący wartość tego wystąpienia.

Przykłady

W poniższym przykładzie pokazano konwertowanie wyliczonej wartości na ciąg.

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

Uwagi

Wartość zwracana jest formatowana za pomocą specyfikatora formatu ogólnego ("G"). Oznacza to, że jeśli parametr FlagsAttribute nie jest stosowany do tego typu wyliczenia i istnieje nazwana stała równa wartości tego wystąpienia, wartość zwracana jest ciągiem zawierającym nazwę stałej. FlagsAttribute Jeśli właściwość jest stosowana i istnieje kombinacja co najmniej jednej nazwanej stałej równej wartości tego wystąpienia, wartość zwracana jest ciągiem zawierającym rozdzielaną ogranicznikami listę nazw stałych. W przeciwnym razie wartość zwracana jest reprezentacją ciągu wartości liczbowej tego wystąpienia. Aby uzyskać więcej informacji na temat formatowania wartości wyliczenia, zobacz Ciągi formatu wyliczenia. Aby uzyskać więcej informacji na temat formatowania ogólnie, zobacz Typy formatowania.

Uwagi dotyczące wywoływania

Jeśli wiele elementów członkowskich wyliczenia ma taką samą wartość bazową i próbujesz pobrać reprezentację ciągu nazwy elementu członkowskiego wyliczenia na podstawie jego wartości bazowej, kod nie powinien przyjąć żadnych założeń dotyczących nazwy zwracanej przez metodę. Na przykład wyliczenie poniżej definiuje dwa elementy członkowskie i Shade.GrayShade.Grey, które mają tę samą wartość bazowa.

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

Następujące wywołanie metody próbuje pobrać nazwę elementu członkowskiego Shade wyliczenia, którego wartość bazowa to 1. Metoda może zwrócić ciąg "Szary" lub "Szary", a kod nie powinien zakładać, który ciąg zostanie zwrócony.

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

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

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

Zobacz też

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

ToString(String)

Źródło:

Enum.cs

Konwertuje wartość tego wystąpienia na równoważną reprezentację ciągu przy użyciu określonego formatu.

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

Parametry

format

String

Ciąg formatu.

Zwraca

String

Ciąg reprezentacja wartości tego wystąpienia określona przez format.

Wyjątki

FormatException

format zawiera nieprawidłową specyfikację.

InvalidOperationException

format równa się "X", ale typ wyliczenia jest nieznany.

Przykłady

W poniższym przykładzie pokazano, jak przekonwertować wartość wyliczeniową na ciąg.

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

Uwagi

Parametr format może być jednym z następujących ciągów formatu: "G" lub "g", "D" lub "d", "X" lub "x" oraz "F" lub "f" (ciąg formatu nie uwzględnia wielkości liter). Jeśli format jest null lub ciąg pusty (""), jest używany ogólny specyfikator formatu ("G"). Aby uzyskać więcej informacji na temat ciągów formatu wyliczenia i wartości wyliczenia formatowania, zobacz Ciągi formatu wyliczenia. Aby uzyskać więcej informacji na temat formatowania ogólnie, zobacz Typy formatowania.

Uwagi dotyczące wywoływania

Jeśli wiele elementów członkowskich wyliczenia ma taką samą wartość bazową i próbujesz pobrać reprezentację ciągu nazwy elementu członkowskiego wyliczenia na podstawie jego wartości bazowej, kod nie powinien przyjąć żadnych założeń dotyczących nazwy zwracanej przez metodę. Na przykład wyliczenie poniżej definiuje dwa elementy członkowskie i Shade.GrayShade.Grey, które mają tę samą wartość bazowa.

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

Następujące wywołanie metody próbuje pobrać nazwę elementu członkowskiego Shade wyliczenia, którego wartość bazowa to 1. Metoda może zwrócić ciąg "Szary" lub "Szary", a kod nie powinien zakładać, który ciąg zostanie zwrócony.

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

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

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

Zobacz też

• Format(Type, Object, String)
• Parse(Type, String)
• ToString(String, IFormatProvider)
• Typy formatowania na platformie .NET
• Ciągi formatu wyliczenia

ToString(IFormatProvider)

Źródło:

Enum.cs

Przestroga

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

To przeciążenie metody jest przestarzałe; użyj polecenia 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

Parametry

provider

IFormatProvider

(przestarzałe)

Zwraca

String

Ciąg reprezentujący wartość tego wystąpienia.

Implementuje

ToString(IFormatProvider)

Atrybuty

ObsoleteAttribute