Enum.ToString Metoda

Definice

Obor názvů:

System

Sestavení:

System.Runtime.dll

Převede hodnotu této instance na její odpovídající řetězcovou reprezentaci.

Přetížení

ToString(String, IFormatProvider)	Zastaralé. Tato metoda přetížení je zastaralá; použijte ToString(String).
ToString()	Převede hodnotu této instance na její odpovídající řetězcovou reprezentaci.
ToString(String)	Převede hodnotu této instance na ekvivalentní řetězcovou reprezentaci pomocí zadaného formátu.
ToString(IFormatProvider)	Zastaralé. Tato metoda přetížení je zastaralá; použijte ToString().

ToString(String, IFormatProvider)

Zdroj:

Enum.cs

Upozornění

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

Tato metoda přetížení je zastaralá; použijte 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

Specifikace formátu.

provider

IFormatProvider

(Zastaralé.)

Návraty

String

Řetězcová reprezentace hodnoty této instance, jak je určena nástrojem 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

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

Zadejte pouze format; provider parametr je zastaralý.

Viz také

• Format(Type, Object, String)
• Typy formátování v .NET
• Řetězce formátu výčtu

ToString()

Zdroj:

Enum.cs

Převede hodnotu této instance na její odpovídající řetězcovou reprezentaci.

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ýčtu hodnoty na řetězec.

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

Poznámky

Vrácená hodnota je naformátovaná pomocí obecného specifikátoru formátu ("G"). To znamená, že pokud FlagsAttribute se na tento výčtový typ nepoužije a existuje pojmenovaná konstanta rovna hodnotě této instance, pak návratová hodnota je řetězec obsahující název konstanty. FlagsAttribute Pokud se použije a existuje kombinace jedné nebo více pojmenovaných konstant rovnajících se hodnotě této instance, je návratová hodnota řetězec obsahující seznam názvů konstant oddělený 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 najdete v tématu Výčet Formát řetězců. Další informace o obecném formátování najdete v tématu Typy formátování.

Poznámky pro volající

Pokud více členů výčtu má stejnou základní hodnotu a pokusíte se načíst řetězcovou reprezentaci názvu člena výčtu na základě jeho základní hodnoty, váš kód by neměl mít žádné předpoklady o tom, který název vrátí metoda. 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

Následující volání metody se pokusí načíst název člena výčtu Shade , jehož podkladová 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 se vrátí.

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

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

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

Viz také

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

ToString(String)

Zdroj:

Enum.cs

Převede hodnotu této instance na ekvivalentní řetězcovou reprezentaci pomocí zadaného formátu.

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

Formátovací řetězec

Návraty

String

Řetězcová reprezentace hodnoty této instance, jak je určena nástrojem 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 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
'

Poznámky

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

Poznámky pro volající

Pokud více členů výčtu má stejnou základní hodnotu a pokusíte se načíst řetězcovou reprezentaci názvu člena výčtu na základě jeho základní hodnoty, váš kód by neměl mít žádné předpoklady o tom, který název vrátí metoda. 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

Následující volání metody se pokusí načíst název člena výčtu Shade , jehož podkladová 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 se vrátí.

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

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

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

Viz také

• Format(Type, Object, String)
• Parse(Type, String)
• ToString(String, IFormatProvider)
• Typy formátování v .NET
• Řetězce formátu výčtu

ToString(IFormatProvider)

Zdroj:

Enum.cs

Upozornění

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

Tato metoda přetížení je zastaralá; použijte 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

(zastaralé)

Návraty

String

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

Implementuje

ToString(IFormatProvider)

Atributy

ObsoleteAttribute