Metoda System.Object.ToString

  • Článek

Tento článek obsahuje doplňující poznámky k referenční dokumentaci pro toto rozhraní API.

Object.ToString je běžná metoda formátování v .NET. Převede objekt na řetězcovou reprezentaci tak, aby byl vhodný pro zobrazení. (Informace o podpoře formátování v .NET najdete v tématu Typy formátování.) Výchozí implementace Object.ToString metody vrací plně kvalifikovaný název typu objektu.

Důležité

Na tuto stránku jste se možná dostali pomocí odkazu ze seznamu členů jiného typu. Je to proto, že tento typ nepřepíše Object.ToString. Místo toho dědí funkce Object.ToString metody.

Typy často přepíší metodu Object.ToString , aby poskytovala vhodnější řetězcovou reprezentaci určitého typu. Typy také často přetěžují metodu Object.ToString tak, aby poskytovala podporu formátovací řetězce nebo formátování citlivé na jazykovou verzi.

Výchozí metoda Object.ToString()

Výchozí implementace ToString metody vrátí plně kvalifikovaný název typu Object, jak ukazuje následující příklad.

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

Vzhledem k tomu Object , že je základní třídou všech referenčních typů v rozhraní .NET, toto chování je zděděno odkazovými typy, které nepřepíší metodu ToString . Toto dokládá následující příklad. Definuje třídu s názvem Object1 , která přijímá výchozí implementaci všech Object členů. Jeho ToString metoda vrátí plně kvalifikovaný název typu objektu.

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

Přepsat Object.ToString() metoda

Typy obvykle přepsat metodu Object.ToString vrácení řetězce, který představuje instanci objektu. Například základní typy, jako Charje , Int32a String poskytují ToString implementace, které vracejí řetězcovou formu hodnoty, kterou objekt představuje. Následující příklad definuje třídu , Object2která přepíše metodu ToString vrátit název typu spolu s jeho hodnotou.

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

Následující tabulka uvádí kategorie typů v .NET a označuje, zda přepíšou metodu Object.ToString .

Kategorie typu Přepisuje Object.ToString() Chování
Třída Není k dispozici Není k dispozici
Struktura Ano (ValueType.ToString) Stejné jako Object.ToString()
Výčet Ano (Enum.ToString()) Jméno člena
Rozhraní No Není k dispozici
Delegát No Není k dispozici

Další informace o přepsání ToStringnaleznete v části Poznámky k dědění.

Přetížení ToString – metoda

Kromě přepsání metody bez Object.ToString() parametrů mnoho typů přetěžuje ToString metodu tak, aby poskytovala verze metody, které přijímají parametry. Nejčastěji se to provádí kvůli podpoře formátování proměnných a formátování citlivého na jazykovou verzi.

Následující příklad přetíží metodu ToString vrácení výsledného řetězce, který obsahuje hodnotu různých polí Automobile třídy. Definuje čtyři formátovací řetězce: G, které vrátí název modelu a rok; D, který vrací název modelu, rok a počet dveří; C, který vrací název modelu, rok a počet válců; a A, který vrátí řetězec se všemi čtyřmi hodnotami polí.

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

Následující příklad volá přetíženou Decimal.ToString(String, IFormatProvider) metodu, která zobrazí formátování měny citlivé na jazykovou verzi.

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

Další informace o formátovacích řetězcích a formátování citlivém na jazykovou verzi najdete v tématu Typy formátování. Formátovací řetězce podporované číselnými hodnotami najdete v tématu Standardní řetězce číselného formátu a vlastní řetězce číselného formátu. Formátovací řetězce podporované hodnotami data a času naleznete v tématu Standardní řetězce formátu data a času a vlastní řetězce formátu data a času.

Rozšíření Object.ToString – metoda

Vzhledem k tomu, že typ dědí výchozí Object.ToString metodu, může být jeho chování nežádoucí a chcete ho změnit. To platí zejména pro pole a třídy kolekce. Ačkoli můžete očekávat, že ToString metoda pole nebo třídy kolekce zobrazí hodnoty jejích členů, místo toho zobrazí typ plně kvalifikovaný název typu, jak ukazuje následující příklad.

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]

Máte několik možností, jak vytvořit výsledný řetězec, který chcete.

  • Pokud je typ pole, objekt kolekce nebo objekt, který implementuje IEnumerable rozhraní IEnumerable<T> , můžete vytvořit výčet jeho prvků pomocí foreach příkazu v jazyce C# nebo For Each...Next konstruktoru v jazyce Visual Basic.

  • Pokud třída není sealed (v jazyce C#) nebo NotInheritable (v jazyce Visual Basic), můžete vyvíjet obálkovou třídu, která dědí ze základní třídy, jejíž Object.ToString metodu chcete přizpůsobit. Minimálně to vyžaduje následující:

    1. Implementujte všechny nezbytné konstruktory. Odvozené třídy nedědí jejich konstruktory základní třídy.
    2. Přepište metodu Object.ToString tak, aby vrátila výsledný řetězec, který chcete.

    Následující příklad definuje obálkovou třídu pro List<T> třídu. Přepíše metodu Object.ToString tak, aby zobrazovala hodnotu každé metody kolekce místo plně kvalifikovaného názvu typu.

    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

  • Vytvořte rozšiřující metodu, která vrátí požadovaný výsledný řetězec. Všimněte si, že výchozí Object.ToString metodu nemůžete tímto způsobem přepsat – to znamená, že třída rozšíření (v jazyce C#) nebo modul (v jazyce Visual Basic) nemůže mít metodu bez parametrů, ToString která je volána místo metody původního typu ToString . Budete muset zadat jiný název pro nahrazení bez ToString parametrů.

    Následující příklad definuje dvě metody, které rozšiřují List<T> třídu: metodu bez ToString2 parametrů a metodu ToStringString s parametrem, který představuje formátovací řetězec.

    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 }

Poznámky k prostředí Windows Runtime

Když voláte metodu ToString třídy v prostředí Windows Runtime, poskytuje výchozí chování tříd, které nepřepíší ToString. Toto je součástí podpory, kterou .NET poskytuje pro prostředí Windows Runtime (viz podpora aplikací pro Windows Store a prostředí Windows Runtime). Třídy v prostředí Windows Runtime nedědí Objecta ne vždy implementují ToString. Zdá se však, že ToStringmají vždy , Equals(Object)a GetHashCode metody, když je použijete v kódu jazyka C# nebo Visual Basic, a .NET poskytuje výchozí chování pro tyto metody.

Modul CLR (Common Language Runtime) používá IStringable.ToString na objektu prostředí Windows Runtime před návratem k výchozí implementaci Object.ToString.

Poznámka:

prostředí Windows Runtime třídy napsané v jazyce C# nebo Visual Basic mohou přepsat metoduToString.

Rozhraní prostředí Windows Runtime a IStringable

Prostředí Windows Runtime obsahuje rozhraní IStringable, jehož jedna metoda, IStringable.ToString, poskytuje základní formát podpory srovnatelné s tím, co poskytuje Object.ToString. Chcete-li zabránit nejednoznačnosti, neměli byste implementovat IStringable u spravovaných typů.

Pokud jsou spravované objekty volány nativním kódem nebo kódem napsaným v jazycích, jako je JavaScript nebo C++/CX, zdá se, že implementují IStringable. Modul CLR (Common Language Runtime) automaticky směruje volání z IStringable.ToString do Object.ToString případě, že IStringable není implementován ve spravovaném objektu.

Upozorňující

Vzhledem k tomu, že modul CLR (Common Language Runtime) automaticky implementuje IStringable pro všechny spravované typy v aplikacích pro Windows Store, doporučujeme neposkytovat vlastní IStringable implementaci. Implementace IStringable může způsobit neočekávané chování při volání ToString z prostředí Windows Runtime, C++/CX nebo JavaScriptu.

Pokud se rozhodnete implementovat IStringable ve veřejném spravovaném typu, který je exportován v komponentě prostředí Windows Runtime, platí následující omezení:

  • Rozhraní IStringable můžete definovat pouze v relaci "class implements" následujícím způsobem:

    public class NewClass : IStringable

    Public Class NewClass : Implements IStringable

  • V rozhraní nelze implementovat IStringable .

  • Nelze deklarovat parametr typu IStringable.

  • IStringable nemůže být návratový typ metody, vlastnosti nebo pole.

  • Implementaci IStringable nelze skrýt ze základních tříd pomocí definice metody, například následující:

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

    Místo toho IStringable.ToString implementace musí vždy přepsat implementaci základní třídy. Implementaci ToString můžete skrýt pouze tak, že ji vyvoláte na instanci třídy silného typu.

Za různých podmínek mohou volání z nativního kódu na spravovaný typ, který implementuje IStringable nebo skryje jeho implementaci ToString , způsobit neočekávané chování.