Enum.ToString Metoda

Definicja

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

Przeciążenia

ToString(String, IFormatProvider)
Przestarzałe.
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.
Przestarzałe.

To przeciążenie metody jest przestarzałe; użyj polecenia ToString().

ToString(String, IFormatProvider)

Źródło:
Enum.cs
Źródło:
Enum.cs
Źródło:
Enum.cs

Przestroga

The provider argument is not used. Please use ToString(String).

Przestroga

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

To przeciążenie metody jest przestarzałe; użyj polecenia ToString(String).

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

Parametry

format
String

Specyfikacja formatu.

provider
IFormatProvider

(Przestarzałe).

Zwraca

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

Implementuje

Atrybuty

Wyjątki

format nie zawiera prawidłowej specyfikacji formatu.

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ż

Dotyczy

.NET 9 i inne wersje
Produkt Wersje (Przestarzałe)
.NET (Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9)
.NET Framework 1.1 (2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1)
.NET Standard (2.0, 2.1)

ToString()

Źródło:
Enum.cs
Źródło:
Enum.cs
Źródło:
Enum.cs

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

C#
public override string ToString ();

Zwraca

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

Przykłady

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

C#
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'.
*/

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.

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

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.

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

Zobacz też

Dotyczy

.NET 9 i inne wersje
Produkt Wersje
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

ToString(String)

Źródło:
Enum.cs
Źródło:
Enum.cs
Źródło:
Enum.cs

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

C#
public string ToString (string format);
C#
public string ToString (string? format);

Parametry

format
String

Ciąg formatu.

Zwraca

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

Wyjątki

format zawiera nieprawidłową specyfikację.

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.

C#
// 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
*/

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.

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

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.

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

Zobacz też

Dotyczy

.NET 9 i inne wersje
Produkt Wersje
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

ToString(IFormatProvider)

Źródło:
Enum.cs
Źródło:
Enum.cs
Źródło:
Enum.cs

Przestroga

The provider argument is not used. Please use ToString().

Przestroga

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

To przeciążenie metody jest przestarzałe; użyj polecenia ToString().

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

Parametry

provider
IFormatProvider

(przestarzałe)

Zwraca

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

Implementuje

Atrybuty

Dotyczy

.NET 9 i inne wersje
Produkt Wersje (Przestarzałe)
.NET (Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9)
.NET Framework 1.1 (2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1)
.NET Standard (2.0, 2.1)