Enum.ToString Metoda

Definice

Obor názvů:
System
Sestavení:
netstandard.dll, System.Runtime.dll
Sestavení:
System.Runtime.dll
Sestavení:
mscorlib.dll
Sestavení:
netstandard.dll
Sestavení:
mscorlib.dll, System.Runtime.dll

Převede hodnotu této instance na ekvivalentní řetězcové vyjádření.

Přetížení

Name Description
ToString(String, IFormatProvider)
Zastaralé.
Zastaralé.

Toto přetížení metody je zastaralé; použít ToString(String).
ToString()

Převede hodnotu této instance na ekvivalentní řetězcové vyjádření.
ToString(String)

Převede hodnotu této instance na ekvivalentní řetězcové vyjádření pomocí zadaného formátu.
ToString(IFormatProvider)
Zastaralé.
Zastaralé.

Toto přetížení metody je zastaralé; použít ToString().

ToString(String, IFormatProvider)

Zdroj:
Enum.cs
Zdroj:
Enum.cs
Zdroj:
Enum.cs
Zdroj:
Enum.cs
Zdroj:
Enum.cs

Upozornění

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

Upozornění

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

Toto přetížení metody je zastaralé; použít 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. Please use ToString(String).")]
public string ToString(string? format, IFormatProvider? provider);
[System.Obsolete("The provider argument is not used. Please use ToString(String).")]
public string ToString(string format, IFormatProvider provider);
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
[<System.Obsolete("The provider argument is not used. Please use ToString(String).")>]
override this.ToString : string * IFormatProvider -> string
override this.ToString : string * IFormatProvider -> string
Public Function ToString (format As String, provider As IFormatProvider) As String

Parametry

format
String

Specifikace formátu.

provider
IFormatProvider

(Zastaralé.)

Návraty

String

Řetězcové vyjádření hodnoty této instance, jak je určeno format.

Implementuje

ToString(String, IFormatProvider)
Atributy
ObsoleteAttribute

Výjimky

FormatException

format neobsahuje platnou specifikaci formátu.

InvalidOperationException

format rovná se "X", ale typ výčtu je neznámý.

Poznámky

Parametrem format může být jeden z následujících formátových řetězců: "G" nebo "g", "D" nebo "d", "X" nebo "x" a "F" nebo "f" (formátovací řetězec nerozlišuje malá a velká písmena). Pokud format je nebo je null prázdný řetězec (""), použije se specifikátor obecného formátu ("G"). Další informace o formátovací řetězce výčtu a formátování hodnot výčtu naleznete v tématu Výčtové formátovací řetězce. Další informace o formátování obecně naleznete v tématu Typy formátování.

Zadejte pouze format; provider parametr je zastaralý.

Viz také

Platí pro

ToString()

Zdroj:
Enum.cs
Zdroj:
Enum.cs
Zdroj:
Enum.cs
Zdroj:
Enum.cs
Zdroj:
Enum.cs

Převede hodnotu této instance na ekvivalentní řetězcové vyjádření.

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

Návraty

String

Řetězcová reprezentace hodnoty této instance.

Příklady

Následující příklad ukazuje převod výčtové hodnoty na řetězec.

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

Poznámky

Návratová hodnota je naformátovaná specifikátorem obecného formátu ("G"). To znamená, že pokud FlagsAttribute není použit pro tento výčtový typ a existuje pojmenovaná konstanta rovna hodnotě této instance, pak vrácená hodnota je řetězec obsahující název konstanty. FlagsAttribute Pokud se použije a existuje kombinace jedné nebo více pojmenovaných konstant, které se rovnají hodnotě této instance, je vrácená hodnota řetězec obsahující seznam názvů konstant oddělených oddělovačem. V opačném případě je návratová hodnota řetězcovou reprezentací číselné hodnoty této instance. Další informace o formátování hodnot výčtu naleznete v tématu Výčtové formátovací řetězce. Další informace o formátování obecně naleznete v tématu Typy formátování.

Poznámky pro volající

Pokud má více členů výčtu stejnou základní hodnotu a pokusíte se načíst řetězcovou reprezentaci názvu člena výčtu na základě jeho podkladové hodnoty, váš kód by neměl provádět žádné předpoklady o tom, který název metoda vrátí. Například následující výčet definuje dva členy Shade.Gray a Shade.Grey, které mají stejnou podkladovou hodnotu.

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

Volání následující metody se pokusí načíst název člena Shade výčtu, jehož základní hodnota je 1. Metoda může vrátit buď "Gray" nebo "Grey", a váš kód by neměl provádět žádné předpoklady o tom, který řetězec bude vrácen.

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

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

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

Viz také

Platí pro

ToString(String)

Zdroj:
Enum.cs
Zdroj:
Enum.cs
Zdroj:
Enum.cs
Zdroj:
Enum.cs
Zdroj:
Enum.cs

Převede hodnotu této instance na ekvivalentní řetězcové vyjádření pomocí zadaného formátu.

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

Parametry

format
String

Formátovací řetězec.

Návraty

String

Řetězcové vyjádření hodnoty této instance, jak je určeno format.

Výjimky

FormatException

format obsahuje neplatnou specifikaci.

InvalidOperationException

format rovná se "X", ale typ výčtu je neznámý.

Příklady

Následující příklad ukazuje, jak převést výčtovou hodnotu na řetězec.

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

Poznámky

Parametrem format může být jeden z následujících formátových řetězců: "G" nebo "g", "D" nebo "d", "X" nebo "x" a "F" nebo "f" (formátovací řetězec nerozlišuje malá a velká písmena). Pokud format je nebo je null prázdný řetězec (""), použije se specifikátor obecného formátu ("G"). Další informace o formátovací řetězce výčtu a formátování hodnot výčtu naleznete v tématu Výčtové formátovací řetězce. Další informace o formátování obecně naleznete v tématu Typy formátování.

Poznámky pro volající

Pokud má více členů výčtu stejnou základní hodnotu a pokusíte se načíst řetězcovou reprezentaci názvu člena výčtu na základě jeho podkladové hodnoty, váš kód by neměl provádět žádné předpoklady o tom, který název metoda vrátí. Například následující výčet definuje dva členy Shade.Gray a Shade.Grey, které mají stejnou podkladovou hodnotu.

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

Volání následující metody se pokusí načíst název člena Shade výčtu, jehož základní hodnota je 1. Metoda může vrátit buď "Gray" nebo "Grey", a váš kód by neměl provádět žádné předpoklady o tom, který řetězec bude vrácen.

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

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

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

Viz také

Platí pro

ToString(IFormatProvider)

Zdroj:
Enum.cs
Zdroj:
Enum.cs
Zdroj:
Enum.cs
Zdroj:
Enum.cs
Zdroj:
Enum.cs

Upozornění

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

Upozornění

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

Toto přetížení metody je zastaralé; použít 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. Please use ToString().")]
public string ToString(IFormatProvider? provider);
[System.Obsolete("The provider argument is not used. Please use ToString().")]
public string ToString(IFormatProvider provider);
public string ToString(IFormatProvider provider);
[<System.Obsolete("The provider argument is not used. Use ToString() instead.")>]
override this.ToString : IFormatProvider -> string
[<System.Obsolete("The provider argument is not used. Please use ToString().")>]
override this.ToString : IFormatProvider -> string
override this.ToString : IFormatProvider -> string
Public Function ToString (provider As IFormatProvider) As String

Parametry

provider
IFormatProvider

(zastaralé)

Návraty

String

Řetězcová reprezentace hodnoty této instance.

Implementuje

ToString(IFormatProvider)
Atributy
ObsoleteAttribute

Platí pro