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

Definición

Convierte el valor de esta instancia en la representación de cadena 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)

Esta sobrecarga del método está en desuso; use ToString(String).This method overload is obsolete; use ToString(String).

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

Convierte el valor de esta instancia en la representación de cadena equivalente usando el 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)

Esta sobrecarga del método está en desuso; use ToString().This method overload is obsolete; use ToString().

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

Convierte el valor de esta instancia en la representación de cadena equivalente.Converts the value of this instance to its equivalent string representation.

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

Advertencia

Esta API está ya obsoleta.

Esta sobrecarga del método está en desuso; 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

Especificación de formato.A format specification.

Devoluciones

Representación en forma de cadena del valor de esta instancia, tal y como especifica format.The string representation of the value of this instance as specified by format.

Implementaciones

Excepciones

format no contiene una especificación de formato válida.format does not contain a valid format specification.

format es igual a "X", pero se desconoce el tipo de enumeración.format equals "X", but the enumeration type is unknown.

Comentarios

El format parámetro puede ser una de las cadenas de formato siguientes: "G" o "g", "D" o "d", "X" o "x" y "F" o "f" (la cadena de formato no distingue entre mayúsculas y 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). Si format esnull o una cadena vacía (""), se usa el especificador de formato general ("G").If format is null or an empty string (""), the general format specifier ("G") is used. Para obtener más información sobre las cadenas de formato de enumeración y los valores de enumeración de formato, vea cadenas de formato de enumeración.For more information about the enumeration format strings and formatting enumeration values, see Enumeration Format Strings. Para obtener más información sobre el formato en general, vea aplicar formato a tipos.For more information about formatting in general, see Formatting Types.

Especifique solo format; el provider parámetro está obsoleto.Specify only format; the provider parameter is obsolete.

Consulte también:

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

Convierte el valor de esta instancia en la representación de cadena equivalente usando el 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

Cadena de formato.A format string.

Devoluciones

Representación en forma de cadena del valor de esta instancia, tal y como especifica format.The string representation of the value of this instance as specified by format.

Excepciones

format contiene una especificación no válida.format contains an invalid specification.

format es igual a "X", pero se desconoce el tipo de enumeración.format equals "X", but the enumeration type is unknown.

Ejemplos

En el ejemplo siguiente se muestra cómo convertir un valor enumerado en una cadena.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)
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
'

Comentarios

El format parámetro puede ser una de las cadenas de formato siguientes: "G" o "g", "D" o "d", "X" o "x" y "F" o "f" (la cadena de formato no distingue entre mayúsculas y 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). Si format esnull o una cadena vacía (""), se usa el especificador de formato general ("G").If format is null or an empty string (""), the general format specifier ("G") is used. Para obtener más información sobre las cadenas de formato de enumeración y los valores de enumeración de formato, vea cadenas de formato de enumeración.For more information about the enumeration format strings and formatting enumeration values, see Enumeration Format Strings. Para obtener más información sobre el formato en general, vea aplicar formato a tipos.For more information about formatting in general, see Formatting Types.

Notas a los autores de las llamadas

Si varios miembros de enumeración tienen el mismo valor subyacente e intenta recuperar la representación de cadena del nombre de un miembro de la enumeración en función de su valor subyacente, el código no debe realizar ninguna suposición sobre el nombre que devolverá el método.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 ejemplo, la enumeración siguiente define dos miembros, Shade. Gray y Shade. Grey, que tienen el mismo valor subyacente.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] La siguiente llamada al método intenta recuperar el nombre de un miembro de la enumeración Shade cuyo valor subyacente es 1.The following method call attempts to retrieve the name of a member of the Shade enumeration whose underlying value is 1. El método puede devolver "Gray" o "Grey", y el código no debe hacer ninguna suposición sobre qué cadena se devolverá.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]

Consulte también:

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

Advertencia

Esta API está ya obsoleta.

Esta sobrecarga del método está en desuso; 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

Devoluciones

Representación de cadena del valor de esta instancia.The string representation of the value of this instance.

Implementaciones

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

Convierte el valor de esta instancia en la representación de cadena 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

Devoluciones

Representación de cadena del valor de esta instancia.The string representation of the value of this instance.

Ejemplos

En el ejemplo siguiente se muestra cómo convertir un valor enumerado en una cadena.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'.
*/
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'.

Comentarios

El valor devuelto se formatea con el especificador de formato general ("G").The return value is formatted with the general format specifier ("G"). Es decir, si FlagsAttribute no se aplica a este tipo enumerado y hay una constante con nombre igual al valor de esta instancia, el valor devuelto es una cadena que contiene el nombre de la 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. FlagsAttribute Si se aplica y hay una combinación de una o varias constantes con nombre iguales al valor de esta instancia, el valor devuelto es una cadena que contiene una lista separada por delimitadores de los nombres de las 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. De lo contrario, el valor devuelto es la representación de cadena del valor numérico de esta instancia.Otherwise, the return value is the string representation of the numeric value of this instance. Para obtener más información sobre cómo aplicar formato a los valores de enumeración, vea cadenas de formato de enumeración.For more information about formatting enumeration values, see Enumeration Format Strings. Para obtener más información sobre el formato en general, vea aplicar formato a tipos.For more information about formatting in general, see Formatting Types.

Notas a los autores de las llamadas

Si varios miembros de enumeración tienen el mismo valor subyacente e intenta recuperar la representación de cadena del nombre de un miembro de la enumeración en función de su valor subyacente, el código no debe realizar ninguna suposición sobre el nombre que devolverá el método.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 ejemplo, la enumeración siguiente define dos miembros, Shade. Gray y Shade. Grey, que tienen el mismo valor subyacente.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] La siguiente llamada al método intenta recuperar el nombre de un miembro de la enumeración Shade cuyo valor subyacente es 1.The following method call attempts to retrieve the name of a member of the Shade enumeration whose underlying value is 1. El método puede devolver "Gray" o "Grey", y el código no debe hacer ninguna suposición sobre qué cadena se devolverá.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]

Consulte también:

Se aplica a