Enum.ToString Metod

public:
 virtual System::String ^ ToString(System::String ^ format, IFormatProvider ^ provider);

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);

override this.ToString : string * IFormatProvider -> string

[<System.Obsolete("The provider argument is not used. Please use ToString(String).")>]
override this.ToString : string * IFormatProvider -> string

Public Function ToString (format As String, provider As IFormatProvider) As String

Parametrar

Returer

Strängrepresentationen av värdet för den här instansen som anges av format.

Implementeringar

Attribut

ObsoleteAttribute

Undantag

Kommentarer

Parametern format kan vara en av följande formatsträngar: "G" eller "g", "D" eller "d", "X" eller "x" och "F" eller "f" (formatsträngen är inte skiftlägeskänslig). Om format är null eller en tom sträng (") används den allmänna formatspecificeraren ("G"). Mer information om uppräkningsformatsträngar och formateringsuppräkningsvärden finns i Uppräkningsformatsträngar. Mer information om formatering i allmänhet finns i Formateringstyper.

Ange endast format; parametern provider är föråldrad.

Se även

• Format(Type, Object, String)
• Formateringstyper i .NET
• Numreringsformatsträngar

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

Parametrar

Returer

Strängrepresentationen av värdet för den här instansen som anges av format.

Undantag

Exempel

I följande exempel visas hur du konverterar ett uppräknat värde till en sträng.

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

Kommentarer

Parametern format kan vara en av följande formatsträngar: "G" eller "g", "D" eller "d", "X" eller "x" och "F" eller "f" (formatsträngen är inte skiftlägeskänslig). Om format är null eller en tom sträng (") används den allmänna formatspecificeraren ("G"). Mer information om uppräkningsformatsträngar och formateringsuppräkningsvärden finns i Uppräkningsformatsträngar. Mer information om formatering i allmänhet finns i Formateringstyper.

Anteckningar till anropare

Om flera uppräkningsmedlemmar har samma underliggande värde och du försöker hämta strängrepresentationen av en uppräkningsmedlems namn baserat på dess underliggande värde bör koden inte göra några antaganden om vilket namn metoden ska returnera. Följande uppräkning definierar till exempel två medlemmar Shade.Gray och Shade.Grey, som har samma underliggande värde.

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

Följande metodanrop försöker hämta namnet på en medlem Shade i uppräkningen vars underliggande värde är 1. Metoden kan returnera antingen "Gray" eller "Grey", och koden bör inte göra några antaganden om vilken sträng som ska returneras.

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

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

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

Se även

• Format(Type, Object, String)
• Parse(Type, String)
• ToString(String, IFormatProvider)
• Formateringstyper i .NET
• Numreringsformatsträngar

public:
 virtual System::String ^ ToString(IFormatProvider ^ provider);

public string ToString(IFormatProvider provider);

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

override this.ToString : IFormatProvider -> string

[<System.Obsolete("The provider argument is not used. Please use ToString().")>]
override this.ToString : IFormatProvider -> string

Public Function ToString (provider As IFormatProvider) As String

Parametrar

Returer

Strängrepresentationen av värdet för den här instansen.

Implementeringar

Attribut

ObsoleteAttribute

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

public override string ToString();

override this.ToString : unit -> string

Public Overrides Function ToString () As String

Returer

Strängrepresentationen av värdet för den här instansen.

Exempel

I följande exempel visas hur du konverterar ett uppräknat värde till en sträng.

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

Kommentarer

Returvärdet formateras med den allmänna formatspecificeraren ("G"). FlagsAttribute Om den inte tillämpas på den här uppräknade typen och det finns en namngiven konstant som är lika med värdet för den här instansen är returvärdet en sträng som innehåller namnet på konstanten. FlagsAttribute Om används och det finns en kombination av en eller flera namngivna konstanter som är lika med värdet för den här instansen är returvärdet en sträng som innehåller en avgränsareavgränsad lista över namnen på konstanterna. Annars är returvärdet strängrepresentationen av det numeriska värdet för den här instansen. Mer information om hur du formaterar uppräkningsvärden finns i Uppräkningsformatsträngar. Mer information om formatering i allmänhet finns i Formateringstyper.

Anteckningar till anropare

Om flera uppräkningsmedlemmar har samma underliggande värde och du försöker hämta strängrepresentationen av en uppräkningsmedlems namn baserat på dess underliggande värde bör koden inte göra några antaganden om vilket namn metoden ska returnera. Följande uppräkning definierar till exempel två medlemmar Shade.Gray och Shade.Grey, som har samma underliggande värde.

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

Följande metodanrop försöker hämta namnet på en medlem Shade i uppräkningen vars underliggande värde är 1. Metoden kan returnera antingen "Gray" eller "Grey", och koden bör inte göra några antaganden om vilken sträng som ska returneras.

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

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

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

Se även

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