Enum.ToString Enum.ToString Enum.ToString Enum.ToString Method

Definição

Converte o valor dessa instância na representação da cadeia de caracteres equivalente.Converts the value of this instance to its equivalent string representation.

Sobrecargas

ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider)

Essa sobrecarga de método é obsoleta; use ToString(String).This method overload is obsolete; use ToString(String).

ToString(String) ToString(String) ToString(String) ToString(String)

Converte o valor dessa instância para sua representação de cadeia de caracteres equivalente usando o formato especificado.Converts the value of this instance to its equivalent string representation using the specified format.

ToString(IFormatProvider) ToString(IFormatProvider) ToString(IFormatProvider) ToString(IFormatProvider)

Essa sobrecarga de método é obsoleta; use ToString().This method overload is obsolete; use ToString().

ToString() ToString() ToString() ToString()

Converte o valor dessa instância na representação da cadeia de caracteres equivalente.Converts the value of this instance to its equivalent string representation.

ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider)

Aviso

Esta API agora é obsoleta.

Essa sobrecarga de método é obsoleta; use ToString(String).This method overload is obsolete; use ToString(String).

public:
 virtual System::String ^ ToString(System::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
Public Function ToString (format As String, provider As IFormatProvider) As String

Parâmetros

format
String String String String

Uma especificação do formato.A format specification.

Retornos

A representação da cadeia de caracteres do valor dessa instância conforme especificado por format.The string representation of the value of this instance as specified by format.

Implementações

Exceções

format não contém uma especificação de formato válida.format does not contain a valid format specification.

format igual a "X", mas o tipo de enumeração é desconhecido.format equals "X", but the enumeration type is unknown.

Comentários

O format parâmetro pode ser uma das seguintes cadeias de caracteres de formato: "G" ou "g", "D" ou "d", "X" ou "x" e "F" ou "f" (a cadeia de caracteres de formato não diferencia maiusculas de minúsculas).The format parameter can be one of the following format strings: "G" or "g", "D" or "d", "X" or "x", and "F" or "f" (the format string is not case-sensitive). Se format é null ou uma cadeia de caracteres vazia (""), o especificador de formato geral ("G") é usado.If format is null or an empty string (""), the general format specifier ("G") is used. Para obter mais informações sobre as cadeias de caracteres de formato de enumeração e a formatação de valores de enumeração, consulte cadeias de caracteres de formato de enumeração.For more information about the enumeration format strings and formatting enumeration values, see Enumeration Format Strings. Para obter mais informações sobre a formatação em geral, consulte tipos de formatação.For more information about formatting in general, see Formatting Types.

Especifique apenas format; o provider parâmetro está obsoleto.Specify only format; the provider parameter is obsolete.

Veja também

ToString(String) ToString(String) ToString(String) ToString(String)

Converte o valor dessa instância para sua representação de cadeia de caracteres equivalente usando o formato especificado.Converts the value of this instance to its equivalent string representation using the specified format.

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

Parâmetros

format
String String String String

Uma cadeia de caracteres de formato.A format string.

Retornos

A representação da cadeia de caracteres do valor dessa instância conforme especificado por format.The string representation of the value of this instance as specified by format.

Exceções

format contém uma especificação inválida.format contains an invalid specification.

format igual a "X", mas o tipo de enumeração é desconhecido.format equals "X", but the enumeration type is unknown.

Exemplos

O exemplo a seguir demonstra como converter um valor enumerado em uma cadeia de caracteres.The following example demonstrates how to convert an enumerated value to a string.

// 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)
Imports System

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 'Main
End Class 'Sample
'
'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
'

Comentários

O format parâmetro pode ser uma das seguintes cadeias de caracteres de formato: "G" ou "g", "D" ou "d", "X" ou "x" e "F" ou "f" (a cadeia de caracteres de formato não diferencia maiusculas de minúsculas).The format parameter can be one of the following format strings: "G" or "g", "D" or "d", "X" or "x", and "F" or "f" (the format string is not case-sensitive). Se format é null ou uma cadeia de caracteres vazia (""), o especificador de formato geral ("G") é usado.If format is null or an empty string (""), the general format specifier ("G") is used. Para obter mais informações sobre as cadeias de caracteres de formato de enumeração e a formatação de valores de enumeração, consulte cadeias de caracteres de formato de enumeração.For more information about the enumeration format strings and formatting enumeration values, see Enumeration Format Strings. Para obter mais informações sobre a formatação em geral, consulte tipos de formatação.For more information about formatting in general, see Formatting Types.

Notas aos Chamadores

Se vários membros de enumeração têm o mesmo valor subjacente, e você tentar recuperar a representação de cadeia de caracteres de nome de um membro enumeração com base no valor subjacente, seu código não deve fazer suposições sobre qual nome, o método será retornado.If multiple enumeration members have the same underlying value and you attempt to retrieve the string representation of an enumeration member's name based on its underlying value, your code should not make any assumptions about which name the method will return. Por exemplo, a seguinte enumeração define dois membros, Shade.Gray e Shade.Grey, que têm o mesmo valor subjacente.For example, the following enumeration defines two members, Shade.Gray and Shade.Grey, that have the same underlying value.

[!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1][!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1] A chamada de método a seguir tenta recuperar o nome de um membro do tonalidade enumeração cujo valor subjacente é 1.The following method call attempts to retrieve the name of a member of the Shade enumeration whose underlying value is 1. O método pode retornar "Gray" ou "Grey" e seu código não deve fazer suposições sobre qual cadeia de caracteres será retornada.The method can return either "Gray" or "Grey", and your code should not make any assumptions about which string will be returned.

[!code-csharpSystem.Enum.ToString#3] [!code-vbSystem.Enum.ToString#3][!code-csharpSystem.Enum.ToString#3] [!code-vbSystem.Enum.ToString#3]

Veja também

ToString(IFormatProvider) ToString(IFormatProvider) ToString(IFormatProvider) ToString(IFormatProvider)

Aviso

Esta API agora é obsoleta.

Essa sobrecarga de método é obsoleta; use ToString().This method overload is obsolete; use ToString().

public:
 virtual System::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
Public Function ToString (provider As IFormatProvider) As String

Parâmetros

Retornos

A representação da cadeia de caracteres do valor dessa instância.The string representation of the value of this instance.

Implementações

ToString() ToString() ToString() ToString()

Converte o valor dessa instância na representação da cadeia de caracteres equivalente.Converts the value of this instance to its equivalent string representation.

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

Retornos

A representação da cadeia de caracteres do valor dessa instância.The string representation of the value of this instance.

Exemplos

O exemplo a seguir demonstra como converter um valor enumerado em uma cadeia de caracteres.The following example demonstrates converting an enumerated value to a string.

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'.
*/
Imports System

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

Comentários

O valor retornado é formatado com o especificador de formato geral ("G").The return value is formatted with the general format specifier ("G"). Ou seja, se o FlagsAttribute não é aplicado a este tipo enumerado e há uma constante nomeada igual ao valor dessa instância, em seguida, o valor retornado é uma cadeia de caracteres que contém o nome da constante.That is, if the FlagsAttribute is not applied to this enumerated type and there is a named constant equal to the value of this instance, then the return value is a string containing the name of the constant. Se o FlagsAttribute é aplicada e uma combinação de um ou mais constantes nomeadas é igual ao valor dessa instância e, em seguida, o valor retornado é uma cadeia de caracteres que contém uma lista separada por delimitador de nomes de constantes.If the FlagsAttribute is applied and there is a combination of one or more named constants equal to the value of this instance, then the return value is a string containing a delimiter-separated list of the names of the constants. Caso contrário, o valor de retorno é a representação de cadeia de caracteres do valor numérico dessa instância.Otherwise, the return value is the string representation of the numeric value of this instance. Para obter mais informações sobre formatação de valores de enumeração, consulte cadeias de caracteres de formato de enumeração.For more information about formatting enumeration values, see Enumeration Format Strings. Para obter mais informações sobre a formatação em geral, consulte tipos de formatação.For more information about formatting in general, see Formatting Types.

Notas aos Chamadores

Se vários membros de enumeração têm o mesmo valor subjacente, e você tentar recuperar a representação de cadeia de caracteres de nome de um membro enumeração com base no valor subjacente, seu código não deve fazer suposições sobre qual nome, o método será retornado.If multiple enumeration members have the same underlying value and you attempt to retrieve the string representation of an enumeration member's name based on its underlying value, your code should not make any assumptions about which name the method will return. Por exemplo, a seguinte enumeração define dois membros, Shade.Gray e Shade.Grey, que têm o mesmo valor subjacente.For example, the following enumeration defines two members, Shade.Gray and Shade.Grey, that have the same underlying value.

[!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1][!code-csharpSystem.Enum.ToString#1] [!code-vbSystem.Enum.ToString#1] A chamada de método a seguir tenta recuperar o nome de um membro do tonalidade enumeração cujo valor subjacente é 1.The following method call attempts to retrieve the name of a member of the Shade enumeration whose underlying value is 1. O método pode retornar "Gray" ou "Grey" e seu código não deve fazer suposições sobre qual cadeia de caracteres será retornada.The method can return either "Gray" or "Grey", and your code should not make any assumptions about which string will be returned.

[!code-csharpSystem.Enum.ToString#2] [!code-vbSystem.Enum.ToString#2][!code-csharpSystem.Enum.ToString#2] [!code-vbSystem.Enum.ToString#2]

Veja também

Aplica-se a