Método System.Object.ToString

En este artículo se proporcionan comentarios adicionales a la documentación de referencia de esta API.

Object.ToString es un método de formato común en .NET. Convierte un objeto en su representación de cadena para que sea adecuado para su presentación. (Para obtener información sobre la compatibilidad con el formato en .NET, consulte Tipos de formato). Las implementaciones predeterminadas del Object.ToString método devuelven el nombre completo del tipo del objeto.

Importante

Es posible que haya llegado a esta página siguiendo el vínculo de la lista de miembros de otro tipo. Esto se debe a que ese tipo no invalida Object.ToString. En su lugar, hereda la funcionalidad del Object.ToString método .

Los tipos invalidan con frecuencia el Object.ToString método para proporcionar una representación de cadena más adecuada de un tipo determinado. Los tipos también sobrecargan con frecuencia el Object.ToString método para proporcionar compatibilidad con cadenas de formato o formato que distingue la referencia cultural.

Método Object.ToString() predeterminado

La implementación predeterminada del ToString método devuelve el nombre completo del tipo de Object, como se muestra en el ejemplo siguiente.

Object obj = new Object();
Console.WriteLine(obj.ToString());

// The example displays the following output:
//      System.Object

let obj = obj ()
printfn $"{obj.ToString()}"
// printfn $"{obj}" // Equivalent

// The example displays the following output:
//      System.Object

Module Example3
    Public Sub Main()
        Dim obj As New Object()
        Console.WriteLine(obj.ToString())
    End Sub
End Module
' The example displays the following output:
'      System.Object

Dado que Object es la clase base de todos los tipos de referencia de .NET, este comportamiento se hereda por tipos de referencia que no invalidan el ToString método. Esto se ilustra en el siguiente ejemplo: Define una clase denominada Object1 que acepta la implementación predeterminada de todos los Object miembros. Su ToString método devuelve el nombre de tipo completo del objeto.

using System;
using Examples;

namespace Examples
{
   public class Object1
   {
   }
}

public class Example5
{
   public static void Main()
   {
      object obj1 = new Object1();
      Console.WriteLine(obj1.ToString());
   }
}
// The example displays the following output:
//   Examples.Object1

type Object1() = class end

let obj1 = Object1()
printfn $"{obj1.ToString()}"
// The example displays the following output:
//   Examples.Object1

Public Class Object1
End Class

Module Example4
    Public Sub Main()
        Dim obj1 As New Object1()
        Console.WriteLine(obj1.ToString())
    End Sub
End Module
' The example displays the following output:
'   Examples.Object1

Invalidación del método Object.ToString()

Los tipos suelen invalidar el Object.ToString método para devolver una cadena que representa la instancia de objeto. Por ejemplo, los tipos base, como Char, Int32y String proporcionan ToString implementaciones que devuelven la forma de cadena del valor que representa el objeto. En el ejemplo siguiente se define una clase , Object2, que invalida el ToString método para devolver el nombre de tipo junto con su valor.

using System;

public class Object2
{
   private object value;

   public Object2(object value)
   {
      this.value = value;
   }

   public override string ToString()
   {
      return base.ToString() + ": " + value.ToString();
   }
}

public class Example6
{
   public static void Main()
   {
      Object2 obj2 = new Object2('a');
      Console.WriteLine(obj2.ToString());
   }
}
// The example displays the following output:
//       Object2: a

type Object2(value: obj) =
    inherit obj ()
    override _.ToString() =
        base.ToString() + ": " + value.ToString()

let obj2 = Object2 'a'
printfn $"{obj2.ToString()}"
// The example displays the following output:
//       Object2: a

Public Class Object2
   Private value As Object
   
   Public Sub New(value As Object)
      Me.value = value
   End Sub
   
   Public Overrides Function ToString() As String
      Return MyBase.ToString + ": " + value.ToString()
   End Function
End Class

Module Example5
    Public Sub Main()
        Dim obj2 As New Object2("a"c)
        Console.WriteLine(obj2.ToString())
    End Sub
End Module
' The example displays the following output:
'       Object2: a

En la tabla siguiente se enumeran las categorías de tipo en .NET e indica si invalidan o no el Object.ToString método.

Categoría de tipo	Invalida Object.ToString()	Comportamiento
Clase	N/D	N/D
Estructura	Sí (ValueType.ToString)	Igual que Object.ToString().
Enumeración	Sí (Enum.ToString())	El nombre del miembro
Interfaz	No	N/D
Delegado	No	N/D

Consulte la sección Notes to Inheritors (Notas para heredar) para obtener información adicional sobre cómo invalidar ToString.

Sobrecarga del método ToString

Además de invalidar el método sin Object.ToString() parámetros, muchos tipos sobrecargan el ToString método para proporcionar versiones del método que aceptan parámetros. Normalmente, esto se hace para proporcionar compatibilidad con el formato de variable y el formato que distingue la referencia cultural.

En el ejemplo siguiente se sobrecarga el ToString método para devolver una cadena de resultado que incluye el valor de varios campos de una Automobile clase. Define cuatro cadenas de formato: G, que devuelve el nombre del modelo y el año; D, que devuelve el nombre del modelo, el año y el número de puertas; C, que devuelve el nombre del modelo, el año y el número de cilindros; y A, que devuelve una cadena con los cuatro valores de campo.

using System;

public class Automobile
{
   private int _doors;
   private string _cylinders;
   private int _year;
   private string _model;

   public Automobile(string model, int year , int doors,
                     string cylinders)
   {
      _model = model;
      _year = year;
      _doors = doors;
      _cylinders = cylinders;
   }

   public int Doors
   { get { return _doors; } }

   public string Model
   { get { return _model; } }

   public int Year
   { get { return _year; } }

   public string Cylinders
   { get { return _cylinders; } }

   public override string ToString()
   {
      return ToString("G");
   }

   public string ToString(string fmt)
   {
      if (string.IsNullOrEmpty(fmt))
         fmt = "G";

      switch (fmt.ToUpperInvariant())
      {
         case "G":
            return string.Format("{0} {1}", _year, _model);
         case "D":
            return string.Format("{0} {1}, {2} dr.",
                                 _year, _model, _doors);
         case "C":
            return string.Format("{0} {1}, {2}",
                                 _year, _model, _cylinders);
         case "A":
            return string.Format("{0} {1}, {2} dr. {3}",
                                 _year, _model, _doors, _cylinders);
         default:
            string msg = string.Format("'{0}' is an invalid format string",
                                       fmt);
            throw new ArgumentException(msg);
      }
   }
}

public class Example7
{
   public static void Main()
   {
      var auto = new Automobile("Lynx", 2016, 4, "V8");
      Console.WriteLine(auto.ToString());
      Console.WriteLine(auto.ToString("A"));
   }
}
// The example displays the following output:
//       2016 Lynx
//       2016 Lynx, 4 dr. V8

open System

type Automobile(model: string, year: int, doors: int, cylinders: string) =
    member _.Doors = doors
    member _.Model = model
    member _.Year = year
    member _.Cylinders = cylinders

    override this.ToString() =
        this.ToString "G"

    member _.ToString(fmt) =
        let fmt = 
            if String.IsNullOrEmpty fmt then "G"
            else fmt.ToUpperInvariant()

        match fmt with
        | "G" ->
            $"{year} {model}"
        | "D" ->
            $"{year} {model}, {doors} dr."
        | "C" ->
            $"{year} {model}, {cylinders}"
        | "A" ->
            $"{year} {model}, {doors} dr. {cylinders}"
        | _ ->
            raise (ArgumentException $"'{fmt}' is an invalid format string")

let auto = Automobile("Lynx", 2016, 4, "V8")
printfn $"{auto}"
printfn $"""{auto.ToString "A"}"""
// The example displays the following output:
//       2016 Lynx
//       2016 Lynx, 4 dr. V8

Public Class Automobile
   Private _doors As Integer
   Private _cylinders As String
   Private _year As Integer
   Private _model As String
   
   Public Sub New(model As String, year As Integer, doors As Integer,
                  cylinders As String)
      _model = model
      _year = year
      _doors = doors
      _cylinders = cylinders
   End Sub
   
   Public ReadOnly Property Doors As Integer
      Get
          Return _doors
      End Get
   End Property
   
   Public ReadOnly Property Model As String
      Get
         Return _model
      End Get
   End Property
   
   Public ReadOnly Property Year As Integer
      Get
         Return _year
      End Get
   End Property
   
   Public ReadOnly Property Cylinders As String
      Get
         Return _cylinders
      End Get
   End Property
   
   Public Overrides Function ToString() As String
      Return ToString("G")
   End Function
   
   Public Overloads Function ToString(fmt As String) As String
      If String.IsNullOrEmpty(fmt) Then fmt = "G"
      
      Select Case fmt.ToUpperInvariant()
         Case "G"
            Return String.Format("{0} {1}", _year, _model)
         Case "D"
            Return String.Format("{0} {1}, {2} dr.",
                                 _year, _model, _doors)
         Case "C"
            Return String.Format("{0} {1}, {2}",
                                 _year, _model, _cylinders)
         Case "A"
            Return String.Format("{0} {1}, {2} dr. {3}",
                                 _year, _model, _doors, _cylinders)
         Case Else
            Dim msg As String = String.Format("'{0}' is an invalid format string",
                                              fmt)
            Throw New ArgumentException(msg)
      End Select
   End Function
End Class

Module Example6
    Public Sub Main()
        Dim auto As New Automobile("Lynx", 2016, 4, "V8")
        Console.WriteLine(auto.ToString())
        Console.WriteLine(auto.ToString("A"))
    End Sub
End Module
' The example displays the following output:
'       2016 Lynx
'       2016 Lynx, 4 dr. V8

En el ejemplo siguiente se llama al método sobrecargado para mostrar el formato que distingue la referencia cultural Decimal.ToString(String, IFormatProvider) de un valor de moneda.

using System;
using System.Globalization;

public class Example8
{
   public static void Main()
   {
      string[] cultureNames = { "en-US", "en-GB", "fr-FR",
                                "hr-HR", "ja-JP" };
      Decimal value = 1603.49m;
      foreach (var cultureName in cultureNames) {
         CultureInfo culture = new CultureInfo(cultureName);
         Console.WriteLine("{0}: {1}", culture.Name,
                           value.ToString("C2", culture));
      }
   }
}
// The example displays the following output:
//       en-US: $1,603.49
//       en-GB: £1,603.49
//       fr-FR: 1 603,49 €
//       hr-HR: 1.603,49 kn
//       ja-JP: ¥1,603.49

open System.Globalization

let cultureNames =
    [| "en-US"; "en-GB"; "fr-FR"; "hr-HR"; "ja-JP" |]
let value = 1603.49m
for cultureName in cultureNames do
    let culture = CultureInfo cultureName
    printfn $"""{culture.Name}: {value.ToString("C2", culture)}"""
// The example displays the following output:
//       en-US: $1,603.49
//       en-GB: £1,603.49
//       fr-FR: 1 603,49 €
//       hr-HR: 1.603,49 kn
//       ja-JP: ¥1,603.49

Imports System.Globalization

Module Example7
    Public Sub Main()
        Dim cultureNames() As String = {"en-US", "en-GB", "fr-FR",
                                       "hr-HR", "ja-JP"}
        Dim value As Decimal = 1603.49D
        For Each cultureName In cultureNames
            Dim culture As New CultureInfo(cultureName)
            Console.WriteLine("{0}: {1}", culture.Name,
                           value.ToString("C2", culture))
        Next
    End Sub
End Module
' The example displays the following output:
'       en-US: $1,603.49
'       en-GB: £1,603.49
'       fr-FR: 1 603,49 €
'       hr-HR: 1.603,49 kn
'       ja-JP: ¥1,603.49

Para obtener más información sobre las cadenas de formato y el formato que distingue la referencia cultural, vea Tipos de formato. Para conocer las cadenas de formato compatibles con valores numéricos, vea Cadenas de formato numérico estándar y Cadenas de formato numérico personalizado. Para conocer las cadenas de formato compatibles con los valores de fecha y hora, vea Cadenas de formato de fecha y hora estándar y cadenas de formato de fecha y hora personalizados.

Extender el método Object.ToString

Dado que un tipo hereda el método predeterminado Object.ToString , puede encontrar su comportamiento no deseado y desea cambiarlo. Esto es especialmente cierto en las matrices y las clases de colección. Aunque puede esperar que el ToString método de una matriz o una clase de colección muestre los valores de sus miembros, en su lugar muestra el nombre de tipo completo, como se muestra en el ejemplo siguiente.

int[] values = { 1, 2, 4, 8, 16, 32, 64, 128 };
Console.WriteLine(values.ToString());

List<int> list = new List<int>(values);
Console.WriteLine(list.ToString());

// The example displays the following output:
//       System.Int32[]
//       System.Collections.Generic.List`1[System.Int32]

let values = [| 1; 2; 4; 8; 16; 32; 64; 128 |]
printfn $"{values}"

let list = ResizeArray values
printfn $"{list}"

// The example displays the following output:
//       System.Int32[]
//       System.Collections.Generic.List`1[System.Int32]

Imports System.Collections.Generic

Module Example
   Public Sub Main()
      Dim values() As Integer = { 1, 2, 4, 8, 16, 32, 64, 128 }
      Console.WriteLine(values.ToString())
      
      Dim list As New List(Of Integer)(values)
      Console.WriteLine(list.ToString())
   End Sub
End Module
' The example displays the following output:
'    System.Int32[]
'    System.Collections.Generic.List`1[System.Int32]

Tiene varias opciones para generar la cadena de resultado que le gustaría.

• Si el tipo es una matriz, un objeto de colección o un objeto que implementa las IEnumerable interfaces o IEnumerable<T> , puede enumerar sus elementos mediante la foreach instrucción en C# o la For Each...Next construcción en Visual Basic.

• Si la clase no sealed es (en C#) o NotInheritable (en Visual Basic), puede desarrollar una clase contenedora que herede de la clase base cuyo Object.ToString método desea personalizar. Como mínimo, esto requiere que haga lo siguiente:

  1. Implemente los constructores necesarios. Las clases derivadas no heredan sus constructores de clase base.
  2. Invalide el Object.ToString método para devolver la cadena de resultado que desea.

  En el ejemplo siguiente se define una clase contenedora para la List<T> clase . Invalida el Object.ToString método para mostrar el valor de cada método de la colección en lugar del nombre de tipo completo.

  using System;
  using System.Collections.Generic;
  
  public class CList<T> : List<T>
  {
     public CList(IEnumerable<T> collection) : base(collection)
     { }
  
     public CList() : base()
     {}
  
     public override string ToString()
     {
        string retVal = string.Empty;
        foreach (T item in this) {
           if (string.IsNullOrEmpty(retVal))
              retVal += item.ToString();
           else
              retVal += string.Format(", {0}", item);
        }
        return retVal;
     }
  }
  
  public class Example2
  {
     public static void Main()
     {
        var list2 = new CList<int>();
        list2.Add(1000);
        list2.Add(2000);
        Console.WriteLine(list2.ToString());
     }
  }
  // The example displays the following output:
  //    1000, 2000
  

  open System
  open System.Collections.Generic
  
  type CList<'T>() = 
      inherit ResizeArray<'T>()
      
      override this.ToString() =
          let mutable retVal = String.Empty
          for item in this do
              if String.IsNullOrEmpty retVal then
                  retVal <- retVal + string item
              else
                  retVal <- retVal + $", {item}"
          retVal
  
  let list2 = CList()
  list2.Add 1000
  list2.Add 2000
  printfn $"{list2}"
  // The example displays the following output:
  //    1000, 2000
  

  Imports System.Collections.Generic
  
  Public Class CList(Of T) : Inherits List(Of T)
     Public Sub New(capacity As Integer)
        MyBase.New(capacity)
     End Sub
  
     Public Sub New(collection As IEnumerable(Of T))
        MyBase.New(collection)
     End Sub
  
     Public Sub New()
        MyBase.New()
     End Sub
  
     Public Overrides Function ToString() As String
        Dim retVal As String = String.Empty
        For Each item As T In Me
           If String.IsNullOrEmpty(retval) Then
              retVal += item.ToString()
           Else
              retval += String.Format(", {0}", item)
           End If
        Next
        Return retVal
     End Function
  End Class
  
  Module Example1
      Public Sub Main()
          Dim list2 As New CList(Of Integer)
          list2.Add(1000)
          list2.Add(2000)
          Console.WriteLine(list2.ToString())
      End Sub
  End Module
  ' The example displays the following output:
  '       1000, 2000
  

• Desarrolle un método de extensión que devuelva la cadena de resultado que desee. Tenga en cuenta que no puede invalidar el método predeterminado Object.ToString de esta manera, es decir, la clase de extensión (en C#) o el módulo (en Visual Basic) no puede tener un método sin parámetros denominado ToString denominado en lugar del método del ToString tipo original. Tendrá que proporcionar algún otro nombre para el reemplazo sin ToString parámetros.

  En el ejemplo siguiente se definen dos métodos que extienden la List<T> clase: un método sin ToString2 parámetros y un ToString método con un String parámetro que representa una cadena de formato.

  using System;
  using System.Collections.Generic;
  
  public static class StringExtensions
  {
     public static string ToString2<T>(this List<T> l)
     {
        string retVal = string.Empty;
        foreach (T item in l)
           retVal += string.Format("{0}{1}", string.IsNullOrEmpty(retVal) ?
                                                       "" : ", ",
                                    item);
        return string.IsNullOrEmpty(retVal) ? "{}" : "{ " + retVal + " }";
     }
  
     public static string ToString<T>(this List<T> l, string fmt)
     {
        string retVal = string.Empty;
        foreach (T item in l) {
           IFormattable ifmt = item as IFormattable;
           if (ifmt != null)
              retVal += string.Format("{0}{1}",
                                      string.IsNullOrEmpty(retVal) ?
                                         "" : ", ", ifmt.ToString(fmt, null));
           else
              retVal += ToString2(l);
        }
        return string.IsNullOrEmpty(retVal) ? "{}" : "{ " + retVal + " }";
     }
  }
  
  public class Example3
  {
     public static void Main()
     {
        List<int> list = new List<int>();
        list.Add(1000);
        list.Add(2000);
        Console.WriteLine(list.ToString2());
        Console.WriteLine(list.ToString("N0"));
     }
  }
  // The example displays the following output:
  //       { 1000, 2000 }
  //       { 1,000, 2,000 }
  

  open System
  open System.Collections.Generic
  
  type List<'T> with
      member this.ToString2<'T>() = 
          let mutable retVal = String.Empty
          for item in this do
             retVal <- retVal + $"""{if String.IsNullOrEmpty retVal then "" else ", "}{item}"""
          if String.IsNullOrEmpty retVal then "{}" else "{ " + retVal + " }"
  
      member this.ToString<'T>(fmt: string) =
          let mutable retVal = String.Empty
          for item in this do
              match box item with
              | :? IFormattable as ifmt ->
                  retVal <- retVal + $"""{if String.IsNullOrEmpty retVal then "" else ", "}{ifmt.ToString(fmt, null)}"""
              | _ ->
                  retVal <- retVal + this.ToString2()
          if String.IsNullOrEmpty retVal then "{}" else "{ " + retVal + " }"
  
  let list = ResizeArray()
  list.Add 1000
  list.Add 2000
  printfn $"{list.ToString2()}"
  printfn $"""{list.ToString "N0"}"""
  // The example displays the following output:
  //       { 1000, 2000 }
  //       { 1,000, 2,000 }
  

  Imports System.Collections.Generic
  Imports System.Runtime.CompilerServices
  
  Public Module StringExtensions
     <Extension()>
     Public Function ToString2(Of T)(l As List(Of T)) As String
        Dim retVal As String = ""
        For Each item As T In l
           retVal += String.Format("{0}{1}", If(String.IsNullOrEmpty(retVal),
                                                       "", ", "),
                                    item)
        Next
        Return If(String.IsNullOrEmpty(retVal), "{}", "{ " + retVal + " }")
     End Function
  
     <Extension()>
     Public Function ToString(Of T)(l As List(Of T), fmt As String) As String
        Dim retVal As String = String.Empty
        For Each item In l
           Dim ifmt As IFormattable = TryCast(item, IFormattable)
           If ifmt IsNot Nothing Then
              retVal += String.Format("{0}{1}",
                                      If(String.IsNullOrEmpty(retval),
                                         "", ", "), ifmt.ToString(fmt, Nothing))
           Else
              retVal += ToString2(l)
           End If
        Next
        Return If(String.IsNullOrEmpty(retVal), "{}", "{ " + retVal + " }")
     End Function
  End Module
  
  Module Example2
      Public Sub Main()
          Dim list As New List(Of Integer)
          list.Add(1000)
          list.Add(2000)
          Console.WriteLine(list.ToString2())
          Console.WriteLine(list.ToString("N0"))
      End Sub
  End Module
  ' The example displays the following output:
  '       { 1000, 2000 }
  '       { 1,000, 2,000 }
  

Notas de Windows Runtime

Cuando llamas al ToString método en una clase de Windows Runtime, proporciona el comportamiento predeterminado para las clases que no invalidan ToString. Esto forma parte de la compatibilidad que .NET proporciona para Windows Runtime (consulte Compatibilidad de .NET con aplicaciones de la Tienda Windows y Windows Runtime). Las clases de Windows Runtime no heredan Objecty no siempre implementan .ToString Sin embargo, siempre parecen tener ToStringmétodos , Equals(Object)y GetHashCode cuando se usan en el código de C# o Visual Basic, y .NET proporciona un comportamiento predeterminado para estos métodos.

Common Language Runtime usa IStringable.ToString en un objeto de Windows Runtime antes de revertir a la implementación predeterminada de Object.ToString.

Nota:

Las clases de Windows Runtime escritas en C# o Visual Basic pueden invalidar el ToString método .

Windows Runtime y la interfaz IStringable

Windows Runtime incluye una interfaz IStringable cuyo único método, IStringable.ToString, proporciona compatibilidad básica de formato comparable a la proporcionada por Object.ToString. Para evitar ambigüedad, no debe implementar IStringable en tipos administrados.

Cuando el código nativo llama a objetos administrados o por código escrito en lenguajes como JavaScript o C++/CX, parecen implementar IStringable. Common Language Runtime enruta automáticamente las llamadas de IStringable.ToString a Object.ToString si IStringable no se implementa en el objeto administrado.

Advertencia

Dado que Common Language Runtime implementa automáticamente IStringable para todos los tipos administrados en aplicaciones de la Tienda Windows, se recomienda no proporcionar su propia IStringable implementación. La implementación IStringable puede dar lugar a un comportamiento no deseado al llamar ToString desde Windows Runtime, C++/CX o JavaScript.

Si decide implementar IStringable en un tipo administrado público que se exporta en un componente de Windows Runtime, se aplican las restricciones siguientes:

• Puede definir la interfaz IStringable solo en una relación "class implements", como se indica a continuación:

  public class NewClass : IStringable
  

  Public Class NewClass : Implements IStringable
  

• No se puede implementar IStringable en una interfaz.

• No se puede declarar un parámetro para que sea de tipo IStringable.

• IStringable no puede ser el tipo de valor devuelto de un método, una propiedad o un campo.

• No se puede ocultar la implementación de IStringable de las clases base mediante una definición de método como la siguiente:

  public class NewClass : IStringable
  {
     public new string ToString()
     {
        return "New ToString in NewClass";
     }
  }
  

  En su lugar, la implementación de IStringable.ToString siempre debe invalidar la implementación de la clase base. Solo puedes ocultar una implementación de ToString invocándola en una instancia de clase fuertemente tipada.

En una variedad de condiciones, las llamadas desde código nativo a un tipo administrado que implementa IStringable u oculta su implementación de ToString pueden producir un comportamiento inesperado.