Méthode System.Object.ToString

Cet article vous offre des remarques complémentaires à la documentation de référence pour cette API.

Object.ToString est une méthode de mise en forme courante dans .NET. Il convertit un objet en sa représentation sous forme de chaîne afin qu’il soit adapté à l’affichage. (Pour plus d’informations sur la prise en charge de la mise en forme dans .NET, consultez Types de mise en forme.) Les implémentations par défaut de la Object.ToString méthode retournent le nom complet du type de l’objet.

Les types remplacent fréquemment la Object.ToString méthode pour fournir une représentation sous forme de chaîne plus appropriée d’un type particulier. Les types surchargent également fréquemment la Object.ToString méthode pour prendre en charge les chaînes de format ou la mise en forme sensible à la culture.

Méthode Object.ToString() par défaut

L’implémentation par défaut de la ToString méthode retourne le nom qualifié complet du type du Object, comme l’illustre l’exemple suivant.

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

Étant donné que Object la classe de base de tous les types de référence dans .NET, ce comportement est hérité par les types de référence qui ne remplacent pas la ToString méthode. L'exemple suivant illustre ce comportement. Elle définit une classe nommée Object1 qui accepte l’implémentation par défaut de tous les Object membres. Sa ToString méthode retourne le nom de type complet de l’objet.

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

Remplacer la méthode Object.ToString()

Les types remplacent généralement la Object.ToString méthode pour retourner une chaîne qui représente l’instance d’objet. Par exemple, les types de base tels que Char, Int32et String fournissent des implémentations qui retournent ToString la forme de chaîne de la valeur que l’objet représente. L’exemple suivant définit une classe, Object2qui remplace la ToString méthode pour retourner le nom du type, ainsi que sa valeur.

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

Le tableau suivant répertorie les catégories de types dans .NET et indique si elles remplacent ou non la Object.ToString méthode.

Pour plus d’informations sur la ToStringsubstitution, consultez la section Notes to Inheritors.

Surcharger la méthode ToString

En plus de remplacer la méthode sans Object.ToString() paramètre, de nombreux types surchargent la ToString méthode pour fournir des versions de la méthode qui acceptent des paramètres. Le plus souvent, cela permet de prendre en charge la mise en forme des variables et la mise en forme sensible à la culture.

L’exemple suivant surcharge la ToString méthode pour retourner une chaîne de résultat qui inclut la valeur de différents champs d’une Automobile classe. Il définit quatre chaînes de format : G, qui retourne le nom du modèle et l’année ; D, qui retourne le nom du modèle, l’année et le nombre de portes ; C, qui retourne le nom du modèle, l’année et le nombre de cylindres ; et A, qui retourne une chaîne avec les quatre valeurs de champ.

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

L’exemple suivant appelle la méthode surchargée Decimal.ToString(String, IFormatProvider) pour afficher la mise en forme sensible à la culture d’une valeur monétaire.

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

Pour plus d’informations sur les chaînes de format et la mise en forme sensible à la culture, consultez Types de mise en forme. Pour connaître les chaînes de format prises en charge par les valeurs numériques, consultez Chaînes de format numérique standard et chaînes de format numérique personnalisées. Pour connaître les chaînes de format prises en charge par les valeurs de date et d’heure, consultez Chaînes de format date et heure standard et chaînes de format de date et d’heure personnalisées.

Étendre la méthode Object.ToString

Étant donné qu’un type hérite de la méthode par défaut Object.ToString , vous pouvez trouver son comportement indésirable et vouloir le modifier. Cela est particulièrement vrai pour les tableaux et les classes de collection. Bien que vous vous attendiez à ce que la ToString méthode d’une classe de tableau ou de collection affiche les valeurs de ses membres, elle affiche plutôt le nom de type complet, comme l’illustre l’exemple suivant.

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]

Vous avez plusieurs options pour produire la chaîne de résultat souhaitée.

• Si le type est un tableau, un objet de collection ou un objet qui implémente le ou IEnumerable<T> les IEnumerable interfaces, vous pouvez énumérer ses éléments à l’aide de l’instruction foreach en C# ou de la For Each...Next construction en Visual Basic.

• Si la classe n’est pas sealed (en C#) ou NotInheritable (en Visual Basic), vous pouvez développer une classe wrapper qui hérite de la classe de base dont Object.ToString vous souhaitez personnaliser la méthode. Au minimum, cela nécessite que vous procédiez comme suit :

  1. Implémentez tous les constructeurs nécessaires. Les classes dérivées n’héritent pas de leurs constructeurs de classe de base.
  2. Remplacez la Object.ToString méthode pour retourner la chaîne de résultat souhaitée.

  L’exemple suivant définit une classe wrapper pour la List<T> classe. Il remplace la Object.ToString méthode pour afficher la valeur de chaque méthode de la collection plutôt que le nom de type complet.

  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
  

• Développez une méthode d’extension qui retourne la chaîne de résultat souhaitée. Notez que vous ne pouvez pas remplacer la méthode par défaut Object.ToString de cette façon, c’est-à-dire que votre classe d’extension (en C#) ou module (en Visual Basic) ne peut pas avoir une méthode sans paramètre nommée ToString appelée à la place de la méthode du ToString type d’origine. Vous devrez fournir un autre nom pour votre remplacement sans ToString paramètre.

  L’exemple suivant définit deux méthodes qui étendent la List<T> classe : une méthode sans ToString2 paramètre et une ToString méthode avec un String paramètre qui représente une chaîne de format.

  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 }
  

Remarques relatives à Windows Runtime

Lorsque vous appelez la ToString méthode sur une classe dans Windows Runtime, elle fournit le comportement par défaut pour les classes qui ne remplacent ToStringpas . Cela fait partie de la prise en charge que .NET fournit pour Windows Runtime (voir prise en charge de .NET pour les applications du Windows Store et Windows Runtime). Les classes dans Windows Runtime n’héritent pas et n’implémentent Objectpas toujours un ToString. Toutefois, ils semblent toujours avoir ToString, Equals(Object)et GetHashCode les méthodes lorsque vous les utilisez dans votre code C# ou Visual Basic, et .NET fournit un comportement par défaut pour ces méthodes.

Le Common Language Runtime utilise IStringable.ToString sur un objet Windows Runtime avant de revenir à l’implémentation par défaut de Object.ToString.

Windows Runtime et l’interface IStringable

Windows Runtime inclut une interface IStringable dont la méthode unique, IStringable.ToStringing, fournit une prise en charge de mise en forme de base comparable à celle fournie par Object.ToString. Pour éviter toute ambiguïté, vous ne devez pas implémenter IStringable sur les types managés.

Lorsque des objets managés sont appelés par du code natif ou par du code écrit dans des langages tels que JavaScript ou C++/CX, ils semblent implémenter IStringable. Le Common Language Runtime achemine automatiquement les appels d’IStringable.ToString vers si Object.ToStringIStringable n’est pas implémenté sur l’objet managé.

Si vous choisissez d’implémenter IStringable dans un type managé public exporté dans un composant Windows Runtime, les restrictions suivantes s’appliquent :

• Vous pouvez définir l’interface IStringable uniquement dans une relation « class implements », comme suit :

  public class NewClass : IStringable
  

  Public Class NewClass : Implements IStringable
  

• Vous ne pouvez pas implémenter IStringable sur une interface.

• Vous ne pouvez pas déclarer un paramètre de type IStringable.

• IStringable ne peut pas être le type de retour d’une méthode, d’une propriété ou d’un champ.

• Vous ne pouvez pas masquer votre implémentation IStringable à partir de classes de base à l’aide d’une définition de méthode telle que la suivante :

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

  Au lieu de cela, l’implémentation IStringable.ToString doit toujours remplacer l’implémentation de classe de base. Vous pouvez masquer une implémentation ToString uniquement en l'appelant sur une instance de classe fortement typée.

Dans diverses conditions, les appels de code natif à un type managé qui implémente IStringable ou masque son implémentation de ToString peuvent produire un comportement inattendu.