Enum.ToString Método

Definición

Convierte el valor de esta instancia en la representación de cadena equivalente.

Sobrecargas

ToString()

Convierte el valor de esta instancia en la representación de cadena equivalente.

ToString(String, IFormatProvider)
Obsoleto.
Obsoleto.

Esta sobrecarga del método está en desuso; use ToString(String).

ToString(String)

Convierte el valor de esta instancia en la representación de cadena equivalente usando el formato especificado.

ToString(IFormatProvider)
Obsoleto.
Obsoleto.

Esta sobrecarga del método está en desuso; use ToString().

ToString()

Convierte el valor de esta instancia en la representación de cadena equivalente.

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

Devoluciones

String

Representación de cadena del valor de esta instancia.

Ejemplos

En el ejemplo siguiente se muestra cómo convertir un valor enumerado en una cadena.

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

Comentarios

El valor devuelto tiene el formato del especificador de formato general ("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. 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. De lo contrario, el valor devuelto es la representación de cadena del valor numérico de esta instancia. Para obtener más información sobre los valores de enumeración de formato, vea Cadenas de formato de enumeración. Para obtener más información sobre el formato en general, vea Tipos de formato.

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 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. Por ejemplo, la siguiente enumeración define dos miembros, Shade.Gray y Shade.Grey, que tienen el mismo valor subyacente.

enum Shade
{
    White = 0, Gray = 1, Grey = 1, Black = 2
}

La siguiente llamada al método intenta recuperar el nombre de un miembro de la enumeración Shade cuyo valor subyacente es 1. El método puede devolver "Gray" o "Grey", y el código no debe realizar ninguna suposición sobre qué cadena se devolverá.

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

Consulte también

Se aplica a

ToString(String, IFormatProvider)

Precaución

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

Precaución

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

Esta sobrecarga del método está en desuso; 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);
[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);
public string ToString (string format, IFormatProvider provider);
[<System.Obsolete("The provider argument is not used. Please use ToString(String).")>]
override this.ToString : string * IFormatProvider -> string
[<System.Obsolete("The provider argument is not used. Use ToString(String) instead.")>]
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

Especificación de formato.

provider
IFormatProvider

(Obsoleto).

Devoluciones

String

Representación en forma de cadena del valor de esta instancia, tal y como especifica format.

Implementaciones

Atributos

Excepciones

format no contiene una especificación de formato válida.

format es igual a "X", pero se desconoce el tipo de enumeración.

Comentarios

El format parámetro puede ser una de las siguientes cadenas de formato: "G" o "g", "D" o "d", "X" o "x" y "F" o "f" (la cadena de formato no distingue mayúsculas de minúsculas). Si format es null o una cadena vacía (""), se usa el especificador de formato general ("G"). 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. Para obtener más información sobre el formato en general, vea Aplicar formato a tipos.

Especifique solo format; el provider parámetro está obsoleto.

Consulte también

Se aplica a

ToString(String)

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

Cadena de formato.

Devoluciones

String

Representación en forma de cadena del valor de esta instancia, tal y como especifica format.

Excepciones

format contiene una especificación no válida.

format es igual a "X", pero se desconoce el tipo de enumeración.

Ejemplos

En el ejemplo siguiente se muestra cómo convertir un valor enumerado en una cadena.

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

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 mayúsculas de minúsculas). Si format es null o una cadena vacía (""), se usa el especificador de formato general ("G"). 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. Para obtener más información sobre el formato en general, vea Tipos de formato.

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 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. Por ejemplo, la enumeración siguiente define dos miembros, Shade.Gray y Shade.Grey, que tienen el mismo valor subyacente.

enum Shade
{
    White = 0, Gray = 1, Grey = 1, Black = 2
}

La siguiente llamada al método intenta recuperar el nombre de un miembro de la enumeración Shade cuyo valor subyacente es 1. El método puede devolver "Gray" o "Grey", y el código no debe realizar ninguna suposición sobre qué cadena se devolverá.

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

Consulte también

Se aplica a

ToString(IFormatProvider)

Precaución

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

Precaución

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

Esta sobrecarga del método está en desuso; 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);
[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);
public string ToString (IFormatProvider provider);
[<System.Obsolete("The provider argument is not used. Please use ToString().")>]
override this.ToString : IFormatProvider -> string
[<System.Obsolete("The provider argument is not used. Use ToString() instead.")>]
override this.ToString : IFormatProvider -> string
override this.ToString : IFormatProvider -> string
Public Function ToString (provider As IFormatProvider) As String

Parámetros

provider
IFormatProvider

(obsoleto)

Devoluciones

String

Representación de cadena del valor de esta instancia.

Implementaciones

Atributos

Se aplica a