System.Object.ToString-Methode

Dieser Artikel enthält ergänzende Hinweise zur Referenzdokumentation für diese API.

Object.ToString ist eine gängige Formatierungsmethode in .NET. Es konvertiert ein Objekt in seine Zeichenfolgendarstellung, sodass es für die Anzeige geeignet ist. (Informationen zur Formatierungsunterstützung in .NET finden Sie unter Formatierungstypen.) Standardimplementierungen der Object.ToString Methode geben den vollqualifizierten Namen des Objekttyps zurück.

Typen setzen die Object.ToString Methode häufig außer Kraft, um eine geeignetere Zeichenfolgendarstellung eines bestimmten Typs bereitzustellen. Typen überladen die Object.ToString Methode auch häufig, um Unterstützung für Formatzeichenfolgen oder kultursensitive Formatierungen bereitzustellen.

Die Standardmethode Object.ToString()

Die Standardimplementierung der ToString Methode gibt den vollqualifizierten Namen des Typs des Typs zurück Object, wie im folgenden Beispiel gezeigt.

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

Da Object es sich um die Basisklasse aller Verweistypen in .NET handelt, wird dieses Verhalten von Verweistypen geerbt, die die ToString Methode nicht überschreiben. Dies wird anhand des folgenden Beispiels veranschaulicht. Sie definiert eine Klasse mit dem Namen Object1 , die die Standardimplementierung aller Object Member akzeptiert. Die ToString Methode gibt den vollqualifizierten Typnamen des Objekts zurück.

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

Überschreiben der Object.ToString() -Methode

Typen überschreiben häufig die Object.ToString Methode, um eine Zeichenfolge zurückzugeben, die die Objektinstanz darstellt. Die Basistypen, z Char. B. , Int32und String stellen ToString Implementierungen bereit, die die Zeichenfolgenform des Werts zurückgeben, den das Objekt darstellt. Im folgenden Beispiel wird eine Klasse definiert, Object2die die ToString Methode außer Kraft setzt, um den Typnamen zusammen mit dem Wert zurückzugeben.

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

In der folgenden Tabelle sind die Typkategorien in .NET aufgeführt und gibt an, ob sie die Object.ToString Methode außer Kraft setzen.

Weitere Informationen zum Überschreiben finden Sie im Abschnitt "Hinweise zu Vererbungen ToString".

Überladung der ToString-Methode

Neben der Außerkraftsetzung der parameterlosen Object.ToString() Methode überladen viele Typen die ToString Methode, um Versionen der Methode bereitzustellen, die Parameter akzeptieren. Dies geschieht am häufigsten, um Unterstützung für variable Formatierungen und kultursensitive Formatierungen bereitzustellen.

Im folgenden Beispiel wird die ToString Methode überladen, um eine Ergebniszeichenfolge zurückzugeben, die den Wert verschiedener Felder einer Automobile Klasse enthält. Es definiert vier Formatzeichenfolgen: G, die den Modellnamen und das Jahr zurückgibt; D, der den Modellnamen, das Jahr und die Anzahl der Türen zurückgibt; C, der den Modellnamen, das Jahr und die Anzahl der Zylinder zurückgibt; und A, die eine Zeichenfolge mit allen vier Feldwerten zurückgibt.

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

Im folgenden Beispiel wird die überladene Decimal.ToString(String, IFormatProvider) Methode aufgerufen, um kultursensitive Formatierungen eines Währungswerts anzuzeigen.

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

Weitere Informationen zum Formatieren von Zeichenfolgen und kulturabhängiger Formatierung finden Sie unter "Formatierungstypen". Die von numerischen Werten unterstützten Formatzeichenfolgen finden Sie unter "Zeichenfolgen im numerischen Standardformat" und "Custom Numeric Format Strings". Die von Datums- und Uhrzeitwerten unterstützten Formatzeichenfolgen finden Sie unter Standard-Datums- und Uhrzeitformatzeichenfolgen sowie benutzerdefinierte Datums- und Uhrzeitformatzeichenfolgen.

Extend the Object.ToString method

Da ein Typ die Standardmethode Object.ToString erbt, finden Sie möglicherweise sein Verhalten unerwünscht und möchten es ändern. Dies gilt insbesondere für Arrays und Sammlungsklassen. Sie können zwar davon ausgehen, dass die ToString Methode einer Array- oder Auflistungsklasse die Werte seiner Member anzeigt, stattdessen wird der vollqualifizierte Typname angezeigt, wie im folgenden Beispiel gezeigt.

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]

Sie haben mehrere Optionen, um die gewünschte Ergebniszeichenfolge zu erstellen.

• Wenn es sich bei dem Typ um ein Array, ein Auflistungsobjekt oder ein Objekt handelt, das die IEnumerable Elemente IEnumerable<T> implementiert, können Sie dessen Elemente mithilfe der foreach Anweisung in C# oder dem For Each...Next Konstrukt in Visual Basic aufzählen.

• Wenn die Klasse nicht sealed (in C#) oder NotInheritable (in Visual Basic) ist, können Sie eine Wrapperklasse entwickeln, die von der Basisklasse erbt, deren Object.ToString Methode Sie anpassen möchten. Dies erfordert mindestens Folgendes:

  1. Implementieren Sie alle erforderlichen Konstruktoren. Abgeleitete Klassen erben ihre Basisklassenkonstruktoren nicht.
  2. Überschreiben Sie die Object.ToString Methode, um die gewünschte Ergebniszeichenfolge zurückzugeben.

  Im folgenden Beispiel wird eine Wrapperklasse für die List<T> Klasse definiert. Sie überschreibt die Object.ToString Methode, um den Wert jeder Methode der Auflistung anstelle des vollqualifizierten Typnamens anzuzeigen.

  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
  

• Entwickeln Sie eine Erweiterungsmethode , die die gewünschte Ergebniszeichenfolge zurückgibt. Beachten Sie, dass Sie die Standardmethode Object.ToString auf diese Weise nicht außer Kraft setzen können, d. h. Ihre Erweiterungsklasse (in C#) oder Das Modul (in Visual Basic) kann keine parameterlose Methode ToString haben, die anstelle der Methode des ursprünglichen Typs ToString aufgerufen wird. Sie müssen einen anderen Namen für den parameterlosen ToString Ersatz angeben.

  Im folgenden Beispiel werden zwei Methoden definiert, die die List<T> Klasse erweitern: eine parameterlose ToString2 Methode und eine ToString Methode mit einem String Parameter, der eine Formatzeichenfolge darstellt.

  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 }
  

Hinweise für die Windows-Runtime

Wenn Sie die ToString Methode für eine Klasse in der Windows-Runtime aufrufen, stellt sie das Standardverhalten für Klassen bereit, die nicht außer Kraft setzenToString. Dies ist Teil der Unterstützung, die .NET für die Windows-Runtime bereitstellt (siehe .NET-Support für Windows Store-Apps und Windows-Runtime). Klassen in der Windows-Runtime erben Objectnicht, und implementieren Sie nicht immer eine ToString. Sie scheinen jedoch immer über , Equals(Object)und GetHashCode Methoden zu verfügenToString, wenn Sie sie in Ihrem C#- oder Visual Basic-Code verwenden, und .NET bietet ein Standardverhalten für diese Methoden.

Die Common Language Runtime verwendet IStringable.ToString für ein Windows-Runtime -Objekt, bevor Sie auf die Standardimplementierung von Object.ToString.

Die Windows-Runtime und die IStringable-Schnittstelle

Die Windows-Runtime enthält eine IStringable-Schnittstelle, deren einzelne Methode IStringable.ToString, bietet grundlegende Formatierungsunterstützung, die mit der von dieser bereitgestelltenObject.ToString. Um Mehrdeutigkeit zu verhindern, sollten Sie IStringable nicht für verwaltete Typen implementieren.

Wenn verwaltete Objekte von systemeigenem Code oder von Code aufgerufen werden, der in Sprachen wie JavaScript oder C++/CX geschrieben wurde, scheinen sie IStringable zu implementieren. Die Common Language Runtime leitet Aufrufe von IStringable.ToString automatisch weiter, Object.ToString wenn IStringable nicht für das verwaltete Objekt implementiert ist.

Wenn Sie IStringable in einem öffentlichen verwalteten Typ implementieren, der in eine Windows-Runtime Komponente exportiert wird, gelten die folgenden Einschränkungen:

• Sie können die IStringable-Schnittstelle nur in einer "Class implements"-Beziehung wie folgt definieren:

  public class NewClass : IStringable
  

  Public Class NewClass : Implements IStringable
  

• IStringable kann nicht auf einer Schnittstelle implementiert werden.

• Sie können keinen Parameter als IStringable-Typ deklarieren.

• IStringable kann nicht der Rückgabetyp einer Methode, Eigenschaft oder eines Felds sein.

• Sie können Ihre IStringable-Implementierung nicht mithilfe einer Methodendefinition wie der folgenden in Basisklassen ausblenden:

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

  Stattdessen muss die IStringable.ToString-Implementierung immer die Basisklassenimplementierung überschreiben. Sie können eine ToString-Implementierung nur ausblenden, indem Sie sie auf einer stark typisierten Klasseninstanz aufrufen.

Unter einer Vielzahl von Bedingungen können Aufrufe von systemeigenem Code zu einem verwalteten Typ, der IStringable implementiert oder seine ToString-Implementierung ausblendet, zu unerwartetem Verhalten führen.