Object.ToString Метод

Определение

Возвращает строку, представляющую текущий объект.

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

Возвращаемое значение

String

Строка, представляющая текущий объект.

Комментарии

Object.ToStringявляется основным методом форматирования в платформа .NET Framework. Он преобразует объект в строковое представление, чтобы его можно было отображать. (сведения о поддержке форматирования в платформа .NET Framework см. в разделе типы форматирования.) Реализации метода по умолчанию Object.ToString возвращают полное имя типа объекта.

Важно!

Возможно, вы достигли этой страницы, следуя ссылке из списка участников другого типа. Это обусловлено тем, что этот тип не переопределяется Object.ToString . Вместо этого он наследует функциональность Object.ToString метода.

Типы часто переопределяют Object.ToString метод, чтобы предоставить более подходящее строковое представление определенного типа. Типы также часто перегружают Object.ToString метод, чтобы обеспечить поддержку для строк формата или форматирования с учетом языка и региональных параметров.

Содержание

Метод Object. ToString () по умолчанию
Переопределение метода Object. ToString ()
Перегрузка метода ToString
Расширение метода Object. ToString
примечания для среда выполнения Windows

Метод Object. ToString () по умолчанию

Реализация метода по умолчанию ToString возвращает полное имя типа Object , как показано в следующем примере.

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

поскольку Object является базовым классом всех ссылочных типов в платформа .NET Framework, это поведение наследуется ссылочными типами, которые не переопределяют ToString метод. Это показано в следующем примере. Он определяет класс с именем Object1 , который принимает реализацию по умолчанию для всех Object элементов. Его ToString метод возвращает полное имя типа объекта.

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

Переопределение метода Object. ToString ()

Типы обычно переопределяют Object.ToString метод для возврата строки, представляющей экземпляр объекта. Например, базовые типы, такие как Char , Int32 и, String предоставляют ToString реализации, возвращающие строковое представление значения, представляемого объектом. В следующем примере определяется класс, Object2 который переопределяет ToString метод для возврата имени типа вместе со значением.

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

В следующей таблице перечислены категории типов в .NET и указано, переопределяются ли они Object.ToString методом.

Категория типа Переопределяет Object. ToString () Поведение
Класс Недоступно Недоступно
structure Да ( ValueType.ToString ) То же, что Object.ToString()
Перечисление Да ( Enum.ToString() ) Имя элемента
Интерфейс нет Недоступно
Делегат нет Недоступно

Дополнительные сведения о переопределении см. в разделе Примечания к наследникам ToString .

Перегрузка метода ToString

Помимо переопределения метода без параметров Object.ToString() , многие типы перегружают ToString метод для предоставления версий метода, принимающих параметры. Чаще всего это делается для обеспечения поддержки форматирования переменных и форматирования с учетом языка и региональных параметров.

В следующем примере метод перегружается ToString для возврата результирующей строки, содержащей значения различных полей Automobile класса. Он определяет четыре строки формата: G, которая возвращает имя модели и год; D, возвращающее имя модели, год и число дверей; C, возвращающее имя модели, год и число цилиндров; и, который возвращает строку со всеми четырьмя значениями полей.

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

В следующем примере вызывается перегруженный Decimal.ToString(String, IFormatProvider) метод для вывода форматирования значения валюты с учетом языка и региональных параметров.

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

Дополнительные сведения о строках форматирования и форматировании с учетом языка и региональных параметров см. в разделе Типы форматирования. Строки формата, поддерживаемые числовыми значениями, см. в разделе строки стандартных числовых форматов и строки настраиваемых числовых форматов. Сведения о строках формата, поддерживаемых значениями даты и времени, см. в разделе строки стандартных форматов даты и времени и строки настраиваемых форматов даты и времени.

Расширение метода Object. ToString

Поскольку тип наследует метод по умолчанию Object.ToString , его поведение может оказаться нежелательным и нужно изменить его. Это особенно справедливо для массивов и классов коллекций. Несмотря на то, что ToString метод массива или класса коллекции может отображать значения его членов, вместо него отображается полное имя типа, как показано в следующем примере.

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]
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]

Есть несколько вариантов для создания результирующей строки, которая вам нужна.

  • Если тип является массивом, объектом коллекции или объектом, реализующим IEnumerable IEnumerable<T> интерфейсы или, можно перечислить его элементы с помощью foreach инструкции в C# или For Each...Next конструкции в Visual Basic.

  • если класс не sealed (в C#) или NotInheritable (в Visual Basic), можно разработать класс-оболочку, который наследует от базового класса, метод которого необходимо Object.ToString настроить. Как минимум, для этого необходимо выполнить следующие действия.

    1. Реализуйте все необходимые конструкторы. Производные классы не наследуют конструкторы базовых классов.

    2. Переопределите Object.ToString метод, чтобы вернуть результирующую строку, которая вам нужна.

    В следующем примере определяется класс-оболочка для List<T> класса. Он переопределяет Object.ToString метод для вывода значения каждого метода коллекции, а не полного имени типа.

    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
    
    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
    
  • Разрабатывайте метод расширения , который возвращает нужную результирующую строку. обратите внимание, что метод по умолчанию нельзя переопределить Object.ToString таким образом (т. е. класс расширения (в C#) или модуль (в Visual Basic) не может иметь метод без параметров с именем ToString , который вызывается вместо метода исходного типа ToString . Вам потребуется указать другое имя для замены без параметров ToString .

    В следующем примере определяются два метода, расширяющие List<T> класс: ToString2 метод без параметров, а также ToString метод с String параметром, представляющим строку формата.

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

примечания для среда выполнения Windows

при вызове ToString метода класса в среда выполнения Windows он предоставляет поведение по умолчанию для классов, которые не переопределяются ToString . это является частью поддержки, предоставляемой платформа .NET Framework для среда выполнения Windows (см. платформа .NET Framework поддержка Windows приложений магазина и среда выполнения Windows). классы в среда выполнения Windows не наследуют Object и не всегда реализуют ToString . однако они всегда имеют ToString Equals(Object) методы, и GetHashCode при их использовании в коде C# или Visual Basic, а платформа .NET Framework предоставляет поведение по умолчанию для этих методов.

начиная с платформа .NET Framework 4.5.1, среда clr использует IStringable. ToString для объекта среда выполнения Windows, прежде чем вернуться к реализации по умолчанию Object.ToString .

Примечание

Windows классы среды выполнения, написанные на языке C# или Visual Basic, могут переопределять ToString метод.

среда выполнения Windows и интерфейс IStringable

начиная с Windows 8.1 среда выполнения Windows включает интерфейс IStringable , единственный метод которого IStringable. ToStringобеспечивает базовую поддержку форматирования, сравнимую с, обеспечиваемую Object.ToString . Чтобы предотвратить неоднозначность, не следует реализовывать IStringable для управляемых типов.

Если управляемые объекты вызываются машинным кодом или кодом, написанным на языках, таких как JavaScript или C++/CX, они выглядят как реализующие IStringable. Среда CLR автоматически направляет вызовы из IStringable. ToString в, Object.ToString Если IStringable не реализован в управляемом объекте.

Предупреждение

так как среда clr auto реализует IStringable для всех управляемых типов в приложениях Windows Store, рекомендуется не предоставлять собственную IStringable реализацию. реализация IStringable может привести к непредвиденному поведению при вызове ToString из среда выполнения Windows, C++/cx или JavaScript.

если вы решили реализовать IStringable в общедоступном управляемом типе, экспортированном в среда выполнения Windows компоненте, применяются следующие ограничения.

  • Интерфейс IStringable можно определить только в связи «класс реализует» следующим образом:

    public class NewClass : IStringable
    
    Public Class NewClass : Implements IStringable
    
  • Невозможно реализовать IStringable в интерфейсе.

  • Нельзя объявить параметр типа IStringable.

  • IStringable не может быть типом возвращаемого значения метода, свойства или поля.

  • Невозможно скрыть реализацию IStringable из базовых классов с помощью определения метода, как показано ниже:

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

    Вместо этого реализация IStringable. ToString должна всегда переопределять реализацию базового класса. Реализацию ToString можно скрыть только путем вызова этого метода в строго типизированном экземпляре класса.

Обратите внимание, что при различных условиях вызовы из машинного кода в управляемый тип, реализующий IStringable или скрывая его реализацию ToString , могут привести к непредвиденному поведению.

Примечания для тех, кто наследует этот метод

При реализации собственных типов следует переопределить ToString() метод, чтобы он возвращал значения, имеющие смысл для этих типов. Производные классы, которым требуется больший контроль над форматированием, чем ToString() предоставляет, могут реализовывать IFormattable интерфейс. Его ToString(String, IFormatProvider) метод позволяет определять строки формата, управляющие форматированием, и использовать IFormatProvider объект, который может обеспечить форматирование для определенного языка и региональных параметров.

Переопределения ToString() метода должны соответствовать следующим рекомендациям: — Возвращаемая строка должна быть понятной и удобочитаемой для людей.

— Возвращаемая строка должна уникальным образом идентифицировать значение экземпляра объекта.

-Возвращаемая строка должна быть максимально короткой, чтобы ее можно было отображать с помощью отладчика.

  • ToString() Переопределение не должно возвращать Empty строку или значение null.

  • ToString() Переопределение не должно вызывать исключение.

— Если строковое представление экземпляра зависит от языка и региональных параметров или может быть отформатировано несколькими способами, реализуйте IFormattable интерфейс.

— Если возвращаемая строка содержит конфиденциальную информацию, необходимо сначала запросить соответствующее разрешение. Если запрос проходит удачно, вы можете вернуть конфиденциальную информацию. в противном случае следует вернуть строку, которая исключается из конфиденциальной информации.

  • ToString() Переопределение не должно иметь наблюдаемых побочных эффектов, чтобы избежать сложностей при отладке. Например, вызов ToString() метода не должен изменять значение полей экземпляра.

— Если тип реализует метод синтаксического анализа (или Parse TryParse метод, конструктор или какой-либо другой статический метод, который создает экземпляр типа из строки), следует убедиться, что строка, возвращаемая ToString() методом, может быть преобразована в экземпляр объекта.

Применяется к

См. также раздел