Číst v angličtině

Sdílet prostřednictvím


Metoda System.Object.ToString

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 naleznete 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řepisují metodu Object.ToString, aby poskytly vhodnější řetězcovou reprezentaci konkrétního typu. Typy také často přetěžují metodu Object.ToString tak, aby poskytovaly podporu pro formátovací řetězce nebo formátování citlivého 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

Protože Object je základní třídou všech referenčních typů v rozhraní .NET, toto chování dědí referenční typy, které nepřepíší metodu ToString. Následující příklad to ilustruje. 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

Provedení přepsání metody Object.ToString()

Typy obvykle přepisují metodu Object.ToString, aby vrátily řetězec, který představuje instanci objektu. Například základní typy, jako jsou Char, Int32 a 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

Následující tabulka uvádí kategorie typů v .NET a zobrazuje, zda přepisují metodu Object.ToString.

Typ kategorie 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í Ne není k dispozici
Delegát Ne není k dispozici

Další informace o přepsání ToString naleznete v sekci Poznámky pro dědice.

Přetížte metodu ToString

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 kulturně citlivého formátování.

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

Následující příklad volá přetíženou Decimal.ToString(String, IFormatProvider) metodu k zobrazení formátování měny citlivého na kulturní rozdíly.

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($"{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

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átů, Vlastní řetězce číselného formátů. 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šířit metodu Object.ToString

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 kolekční třídy. 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]

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
    
  • 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 }
    

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í Object a ne vždy implementují ToString. Zdá se však, že vždy mají metody ToString, Equals(Object) a GetHashCode, když je použijete v kódu C# nebo Visual Basic, a .NET pro tyto metody poskytuje výchozí chování.

Common Language Runtime používá IStringable.ToString v objektu Windows Runtime před návratem k výchozí implementaci Object.ToString.

Poznámka

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

Prostředí Windows Runtime a rozhraní „IStringable“

Modul Windows Runtime obsahuje rozhraní IStringable , jehož jedna metoda , IStringable.ToString, poskytuje základní podporu formátování 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.

Upozornění

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 mít za následek 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ě 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
    
  • 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 před základními třídami pomocí definice metody, jako je tato:

    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 může 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í.


Další materiály

Školení

Modul

Implementace dědičnosti tříd - Training

Zjistěte, jak vytvořit hierarchii tříd pomocí základních a odvozených tříd a jak skrýt nebo přepsat členy odvozené třídy pomocí klíčových slov "new", "virtual", "abstract" a "override".