Object.ToString Methode

Definition

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.

public:
 virtual System::String ^ ToString();
public virtual string ToString ();
public virtual string? ToString ();
abstract member ToString : unit -> string
override this.ToString : unit -> string
Public Overridable Function ToString () As String

Gibt zurück

String

Eine Zeichenfolge, die das aktuelle Objekt darstellt.

Hinweise

Object.ToStringist die Hauptformatierungsmethode im .NET Framework. Es konvertiert ein Objekt in seine Zeichenfolgendarstellung, sodass er für die Anzeige geeignet ist. (Informationen zur Formatierungsunterstützung im .NET Framework finden Sie unter Formatierungstypen.) Standardmäßige Implementierungen der Object.ToString Methode geben den vollqualifizierten Namen des Typs des Objekts zurück.

Wichtig

Möglicherweise haben Sie diese Seite erreicht, indem Sie dem Link aus der Memberliste eines anderen Typs folgen. Das liegt daran, dass dieser Typ nicht außer Kraft setzt Object.ToString. Stattdessen erbt er die Funktionalität der Object.ToString Methode.

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

In diesem Abschnitt

Die Standardmethode Object.ToString()
Überschreiben der Object.ToString() -Methode
Überladen der ToString-Methode
Erweitern der Object.ToString-Methode
Notizen für die Windows-Runtime

Die Standardmethode Object.ToString()

Die Standardimplementierung der ToString Methode gibt den vollqualifizierten Namen des Typs des Typs des ObjectTyps zurück, wie das folgende Beispiel zeigt.

using namespace System;

void main()
{
   Object^ obj = gcnew Object();
   Console::WriteLine(obj->ToString());
}
// The example displays the following output:
//      System.Object
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 Example
   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 Referenztypen im .NET Framework handelt, wird dieses Verhalten von Referenztypen geerbt, die die ToString Methode nicht außer Kraft setzen. Dies wird anhand des folgenden Beispiels veranschaulicht. Es definiert eine Klasse namens " Object1 , die die Standardimplementierung aller Object Member akzeptiert. Die ToString Methode gibt den vollqualifizierten Typnamen des Objekts zurück.

using namespace System;

namespace Examples
{
   ref class Object1
   {
   };
}

void main()
{
   Object^ obj1 = gcnew Examples::Object1();
   Console::WriteLine(obj1->ToString());
}
// The example displays the following output:
//   Examples.Object1
using System;
using Examples;

namespace Examples
{
   public class Object1
   {
   }
}

public class Example
{
   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
Imports Examples

Namespace Examples
   Public Class Object1
   End Class
End Namespace

Module Example
   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 setzen die Object.ToString Methode häufig außer Kraft, um eine Zeichenfolge zurückzugeben, die die Objektinstanz darstellt. Beispielsweise geben die Basistypen wie Char, und Int32String stellen ToString Sie Implementierungen bereit, die das Zeichenfolgenformular 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 namespace System;

ref class Object2
{
   private:
      Object^ value;

   public:
      Object2(Object^ value)
      {
         this->value = value;
      }

      virtual String^ ToString() override
      {
         return Object::ToString() + ": " + value->ToString();
      }
};

void main()
{
   Object2^ obj2 = gcnew Object2(L'a');
   Console::WriteLine(obj2->ToString());
 
}
// The example displays the following output:
//       Object2: a
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 Example
{
   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 Example
   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.

Typkategorie Overrides Object.ToString() Verhalten
Klasse
Struktur Ja (ValueType.ToString) Identisch mit Object.ToString()
Enumeration Ja (Enum.ToString()) Der Membername
Schnittstelle Nein
Delegat Nein

Weitere Informationen zum Außerkraftsetzen ToStringfinden Sie im Abschnitt "Hinweise zu Erben".

Überladen der ToString-Methode

Zusätzlich zur 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 kulturempfindliche 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 Example
{
   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 Example
   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 kulturempfindliche Formatierungen eines Währungswerts anzuzeigen.

using System;
using System.Globalization;

public class Example
{
   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 Example
   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 kulturempfindlichen Formatierungen finden Sie unter Formatierungstypen. Informationen zu den Formatzeichenfolgen, die von numerischen Werten unterstützt werden, finden Sie unter Standard-Numerische Formatzeichenfolgen und benutzerdefinierte numerische Formatzeichenfolgen. Informationen zu den Formatzeichenfolgen, die von Datums- und Uhrzeitwerten unterstützt werden, finden Sie unter Standarddatums- und Uhrzeitformatzeichenfolgen und benutzerdefinierte Datums- und Uhrzeitformatzeichenfolgen.

Erweitern der Object.ToString-Methode

Da ein Typ die Standardmethode Object.ToString erbt, finden Sie möglicherweise sein Verhalten unerwünschtes Und möchten es ändern. Dies gilt insbesondere für Arrays und Auflistungsklassen. Während Sie möglicherweise erwarten, dass die ToString Methode einer Array- oder Auflistungsklasse die Werte seiner Member anzeigt, zeigt sie stattdessen den vollqualifizierten Typnamen an, wie das folgende Beispiel zeigt.

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 Schnittstellen IEnumerable<T> implementiert, können Sie seine 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. Es ü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 Example
    {
       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 Example
       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 nicht auf diese Weise außer Kraft setzen können (d. h. Die 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 Example
    {
       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 Example
       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 im Windows-Runtime aufrufen, stellt sie das Standardverhalten für Klassen bereit, die nicht außer Kraft setzenToString. Dies ist Teil der Unterstützung, die der .NET Framework für die Windows-Runtime bereitstellt (siehe .NET Framework 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 Methoden Equals(Object)und GetHashCode Methoden zu verfügenToString, wenn Sie sie in Ihrem C#- oder Visual Basic Code verwenden, und die .NET Framework stellt ein Standardverhalten für diese Methoden bereit.

Ab .NET Framework 4.5.1 verwendet die allgemeine Sprachlaufzeit IStringable.ToString für ein Windows-Runtime-Objekt, bevor sie zurück zur Standardimplementierung von Object.ToString.

Hinweis

Windows-Runtime Klassen, die in C# geschrieben wurden, oder Visual Basic können die ToString Methode außer Kraft setzen.

Die Windows-Runtime und die IStringable-Schnittstelle

Ab Windows 8.1 enthält die Windows-Runtime eine IStringable-Schnittstelle, deren einzelne Methode IStringable.ToString, eine grundlegende Formatierungsunterstützung bereitstellt, die mit dem von Object.ToString. Um Ambiguität zu verhindern, sollten Sie IStringable nicht auf verwalteten Typen implementieren.

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

Warnung

Da die allgemeine Sprachlaufzeit IStringable für alle verwalteten Typen in Windows Store Apps automatisch implementiert, empfehlen wir, keine eigene IStringable Implementierung bereitzustellen. Die Implementierung IStringable kann beim Aufrufen ToString von Windows-Runtime, C++/CX oder JavaScript zu unbeabsichtigten Verhaltensweisen führen.

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

  • Sie können die IStringable-Schnittstelle nur in einer Beziehung "Klasse implementiert" 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 aus Basisklassen ausblenden, indem Sie eine Methodendefinition wie die folgenden verwenden:

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

    Stattdessen muss die IStringable.ToString-Implementierung immer die Basisklassenimplementierung außer Kraft setzen. Sie können eine ToString-Implementierung nur ausblenden, indem Sie sie auf einer stark typisierten Klasseninstanz aufrufen.

Beachten Sie, dass Aufrufe von systemeigenem Code zu einem verwalteten Typ, der IStringable implementiert oder seine ToString-Implementierung ausblendet, unerwartetes Verhalten erzeugen kann.

Hinweise für Vererber

Wenn Sie Eigene Typen implementieren, sollten Sie die Methode außer Kraft setzen, um Werte zurückzugeben, die ToString() für diese Typen sinnvoll sind. Abgeleitete Klassen, die mehr Kontrolle über die Formatierung erfordern als ToString() bereitgestellt, können die IFormattable Schnittstelle implementieren. Die ToString(String, IFormatProvider) Methode ermöglicht es Ihnen, Formatzeichenfolgen zu definieren, die die Formatierung steuern und ein IFormatProvider Objekt verwenden, das für kulturspezifische Formatierungen sorgen kann.

Außerkraftsetzungen der ToString() Methode sollten den folgenden Richtlinien entsprechen:

  • Die zurückgegebene Zeichenfolge sollte von Menschen freundlich und lesbar sein.

  • Die zurückgegebene Zeichenfolge sollte den Wert der Objektinstanz eindeutig identifizieren.

  • Die zurückgegebene Zeichenfolge sollte so kurz wie möglich sein, damit sie für die Anzeige durch einen Debugger geeignet ist.

  • Die ToString() Außerkraftsetzung sollte nicht zurückgegeben Empty werden oder eine NULL-Zeichenfolge.

  • Ihre ToString() Außerkraftsetzung sollte keine Ausnahme auslösen.

  • Wenn die Zeichenfolgendarstellung einer Instanz kulturempfindlich ist oder auf mehrere Arten formatiert werden kann, implementieren Sie die IFormattable Schnittstelle.

  • Wenn die zurückgegebene Zeichenfolge vertrauliche Informationen enthält, sollten Sie zuerst eine entsprechende Berechtigung verlangen. Wenn die Nachfrage erfolgreich ist, können Sie die vertraulichen Informationen zurückgeben; andernfalls sollten Sie eine Zeichenfolge zurückgeben, die die vertraulichen Informationen ausschließt.

  • Ihre ToString() Außerkraftsetzung sollte keine beobachtbaren Nebenwirkungen haben, um Komplikationen beim Debuggen zu vermeiden. Beispielsweise sollte ein Aufruf der ToString() Methode den Wert von Instanzfeldern nicht ändern.

  • Wenn Ihr Typ eine Analysemethode (oder Parse TryParse Methode, einen Konstruktor oder eine andere statische Methode implementiert, die eine Instanz des Typs aus einer Zeichenfolge instanziiert), sollten Sie sicherstellen, dass die von der ToString() Methode zurückgegebene Zeichenfolge in eine Objektinstanz konvertiert werden kann.

Gilt für:

Siehe auch