Enum.ToString Método

Definição

Converte o valor desta instância para a sua representação equivalente da cadeia.

Sobrecargas

Name Description
ToString(String, IFormatProvider)
Obsoleto.
Obsoleto.

Esta sobrecarga de métodos é obsoleta; usar ToString(String).

ToString()

Converte o valor desta instância para a sua representação equivalente da cadeia.

ToString(String)

Converte o valor desta instância para a sua representação equivalente de cadeias usando o formato especificado.

ToString(IFormatProvider)
Obsoleto.
Obsoleto.

Esta sobrecarga de métodos é obsoleta; usar ToString().

ToString(String, IFormatProvider)

Origem:
Enum.cs
Origem:
Enum.cs
Origem:
Enum.cs
Origem:
Enum.cs
Origem:
Enum.cs

Atenção

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

Atenção

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

Esta sobrecarga de métodos é obsoleta; usar 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

Parâmetros

format
String

Uma especificação de formato.

provider
IFormatProvider

(Obsoleto.)

Devoluções

A representação da cadeia do valor desta instância conforme especificado por format.

Implementações

Atributos

Exceções

format não contém uma especificação de formato válida.

format é igual a "X", mas o tipo de enumeração é desconhecido.

Observações

O format parâmetro pode ser uma das seguintes cadeias de formato: "G" ou "g", "D" ou "d", "X" ou "x", e "F" ou "f" (a cadeia de formato não distingue maiúsculas e minúsculas). Se format for null ou uma cadeia vazia (""), utiliza-se o especificador geral de formato ("G"). Para mais informações sobre as cadeias de formatos de enumeração e os valores de formatação, consulte Strings de Formato de Enumeração. Para mais informações sobre formatação em geral, consulte Tipos de Formatação.

Especifique apenas format; o provider parâmetro está obsoleto.

Ver também

Aplica-se a

ToString()

Origem:
Enum.cs
Origem:
Enum.cs
Origem:
Enum.cs
Origem:
Enum.cs
Origem:
Enum.cs

Converte o valor desta instância para a sua representação equivalente da cadeia.

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

Devoluções

A representação da cadeia do valor desta instância.

Exemplos

O exemplo seguinte demonstra a conversão de um valor enumerado numa cadeia.

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

Observações

O valor de retorno é formatado com o especificador geral de formato ("G"). Ou seja, se o FlagsAttribute não for aplicado a este tipo enumerado e houver uma constante nomeada igual ao valor desta instância, então o valor de retorno é uma cadeia contendo o nome da constante. Se for aplicado e FlagsAttribute houver uma combinação de uma ou mais constantes nomeadas iguais ao valor desta instância, então o valor de retorno é uma cadeia contendo uma lista separada dos delimitadores com os nomes das constantes. Caso contrário, o valor de retorno é a representação em cadeia do valor numérico desta instância. Para mais informações sobre a formatação dos valores de enumeração, consulte Strings de Formato de Enumeração. Para mais informações sobre formatação em geral, consulte Tipos de Formatação.

Notas para Chamadores

Se múltiplos membros de enumeração tiverem o mesmo valor subjacente e tentares recuperar a representação da cadeia do nome de um membro de enumeração com base no seu valor subjacente, o teu código não deve fazer quaisquer suposições sobre qual nome o método irá devolver. Por exemplo, a enumeração seguinte define dois membros, Shade.Gray e Shade.Grey, que têm o mesmo valor subjacente.

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

A seguinte chamada de método tenta recuperar o nome de um membro da Shade enumeração cujo valor subjacente é 1. O método pode devolver tanto "Gray" como "Grey", e o seu código não deve fazer quaisquer suposições sobre qual string será devolvida.

string shadeName = ((Shade) 1).ToString();
let shadeName = (enum<Shade> 1).ToString()
Dim shadeName As String = CType(1, Shade).ToString()

Ver também

Aplica-se a

ToString(String)

Origem:
Enum.cs
Origem:
Enum.cs
Origem:
Enum.cs
Origem:
Enum.cs
Origem:
Enum.cs

Converte o valor desta instância para a sua representação equivalente de cadeias usando o formato especificado.

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

Parâmetros

format
String

Uma cadeia de formato.

Devoluções

A representação da cadeia do valor desta instância conforme especificado por format.

Exceções

format contém uma especificação inválida.

format é igual a "X", mas o tipo de enumeração é desconhecido.

Exemplos

O exemplo seguinte demonstra como converter um valor enumerado numa cadeia.

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

Observações

O format parâmetro pode ser uma das seguintes cadeias de formato: "G" ou "g", "D" ou "d", "X" ou "x", e "F" ou "f" (a cadeia de formato não distingue maiúsculas e minúsculas). Se format for null ou uma cadeia vazia (""), utiliza-se o especificador geral de formato ("G"). Para mais informações sobre as cadeias de formatos de enumeração e os valores de formatação, consulte Strings de Formato de Enumeração. Para mais informações sobre formatação em geral, consulte Tipos de Formatação.

Notas para Chamadores

Se múltiplos membros de enumeração tiverem o mesmo valor subjacente e tentares recuperar a representação da cadeia do nome de um membro de enumeração com base no seu valor subjacente, o teu código não deve fazer quaisquer suposições sobre qual nome o método irá devolver. Por exemplo, a enumeração seguinte define dois membros, Shade.Gray e Shade.Grey, que têm o mesmo valor subjacente.

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

A seguinte chamada de método tenta recuperar o nome de um membro da Shade enumeração cujo valor subjacente é 1. O método pode devolver tanto "Gray" como "Grey", e o seu código não deve fazer quaisquer suposições sobre qual string será devolvida.

string shadeName = ((Shade) 1).ToString("F");
let shadeName = (enum<Shade> 1).ToString "F"
Dim shadeName As String = CType(1, Shade).ToString("F")

Ver também

Aplica-se a

ToString(IFormatProvider)

Origem:
Enum.cs
Origem:
Enum.cs
Origem:
Enum.cs
Origem:
Enum.cs
Origem:
Enum.cs

Atenção

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

Atenção

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

Esta sobrecarga de métodos é obsoleta; usar 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

Parâmetros

provider
IFormatProvider

(obsoleto)

Devoluções

A representação da cadeia do valor desta instância.

Implementações

Atributos

Aplica-se a