Object.ToString Метод

Определение

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

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

Возвраты

Строка, представляющая текущий объект.A string that represents the current object.

Комментарии

Object.ToStringявляется основным методом форматирования в .NET Framework.Object.ToString is the major formatting method in the .NET Framework. Он преобразует объект в строковое представление, чтобы его можно было отображать.It converts an object to its string representation so that it is suitable for display. (Сведения о поддержке форматирования в .NET Framework см. в разделе Типы форматирования.) Реализации Object.ToString метода по умолчанию возвращают полное имя типа объекта.(For information about formatting support in the .NET Framework, see Formatting Types.) Default implementations of the Object.ToString method return the fully qualified name of the object's type.

Важно!

Возможно, вы достигли этой страницы, следуя ссылке из списка участников другого типа.You may have reached this page by following the link from the member list of another type. Это обусловлено тем, что этот тип Object.ToStringне переопределяется.That is because that type does not override Object.ToString. Вместо этого он наследует функциональность Object.ToString метода.Instead, it inherits the functionality of the Object.ToString method.

Типы часто переопределяют Object.ToString метод, чтобы предоставить более подходящее строковое представление определенного типа.Types frequently override the Object.ToString method to provide a more suitable string representation of a particular type. Типы также часто перегружают Object.ToString метод, чтобы обеспечить поддержку для строк формата или форматирования с учетом языка и региональных параметров.Types also frequently overload the Object.ToString method to provide support for format strings or culture-sensitive formatting.

СодержаниеIn this section:

Метод Object. ToString () по умолчанию The default Object.ToString() method
Переопределение метода Object. ToString () Overriding the Object.ToString() method
Перегрузка метода ToString Overloading the ToString method
Расширение метода Object. ToString Extending the Object.ToString method
Примечания для среда выполнения WindowsNotes for the Windows Runtime

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

Реализация ToString метода по умолчанию возвращает полное имя типа Object, как показано в следующем примере.The default implementation of the ToString method returns the fully qualified name of the type of the Object, as the following example shows.

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 переопределяют метод.Because Object is the base class of all reference types in the .NET Framework, this behavior is inherited by reference types that do not override the ToString method. Это показано в следующем примере.The following example illustrates this. Он определяет класс с именем Object1 , который принимает реализацию по умолчанию Object для всех элементов.It defines a class named Object1 that accepts the default implementation of all Object members. Его ToString метод возвращает полное имя типа объекта.Its ToString method returns the object's fully qualified type name.

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 ()Overriding the Object.ToString() method

Типы обычно переопределяют Object.ToString метод для возврата строки, представляющей экземпляр объекта.Types commonly override the Object.ToString method to return a string that represents the object instance. Например, базовые типы, такие Charкак, Int32и String , предоставляют ToString реализации, возвращающие строковое представление значения, представляемого объектом.For example, the base types such as Char, Int32, and String provide ToString implementations that return the string form of the value that the object represents. В следующем примере определяется класс, Object2который ToString переопределяет метод для возврата имени типа вместе со значением.The following example defines a class, Object2, that overrides the ToString method to return the type name along with its value.

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 ли они методом.The following table lists the type categories in .NET and indicates whether or not they override the Object.ToString method.

Категория типаType category Переопределяет Object. ToString ()Overrides Object.ToString() ПоведениеBehavior
КлассClass Н/Дn/a Н/Дn/a
СтруктураStructure Да (ValueType.ToString)Yes (ValueType.ToString) Аналогично Object.ToString()Same as Object.ToString()
ПеречислениеEnumeration Да (Enum.ToString())Yes (Enum.ToString()) Имя элементаThe member name
ИнтерфейсInterface НетNo Н/Дn/a
делегатDelegate НетNo Н/Дn/a

Дополнительные сведения о переопределении ToStringсм. в разделе Примечания к наследникам.See the Notes to Inheritors section for additional information on overriding ToString.

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

Помимо переопределения Object.ToString() метода без параметров, многие типы ToString перегружают метод для предоставления версий метода, принимающих параметры.In addition to overriding the parameterless Object.ToString() method, many types overload the ToString method to provide versions of the method that accept parameters. Чаще всего это делается для обеспечения поддержки форматирования переменных и форматирования с учетом языка и региональных параметров.Most commonly, this is done to provide support for variable formatting and culture-sensitive formatting.

В следующем примере ToString метод перегружается для возврата результирующей строки, содержащей значения различных полей Automobile класса.The following example overloads the ToString method to return a result string that includes the value of various fields of an Automobile class. Он определяет четыре строки формата: G, который возвращает имя модели и год; D, возвращающее имя модели, год и число дверей; C, возвращающее имя модели, год и число цилиндров; и, который возвращает строку со всеми четырьмя значениями полей.It defines four format strings: G, which returns the model name and year; D, which returns the model name, year, and number of doors; C, which returns the model name, year, and number of cylinders; and A, which returns a string with all four field values.

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) метод для вывода форматирования значения валюты с учетом языка и региональных параметров.The following example calls the overloaded Decimal.ToString(String, IFormatProvider) method to display culture-sensitive formatting of a currency value.

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

Дополнительные сведения о строках форматирования и форматировании с учетом языка и региональных параметров см. в разделе Типы форматирования.For more information on format strings and culture-sensitive formatting, see Formatting Types. Строки формата, поддерживаемые числовыми значениями, см. в разделе строки стандартных числовых форматов и строки настраиваемых числовых форматов.For the format strings supported by numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. Сведения о строках формата, поддерживаемых значениями даты и времени, см. в разделе строки стандартных форматов даты и времени и строки настраиваемых форматов даты и времени.For the format strings supported by date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings.

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

Поскольку тип наследует метод по умолчанию Object.ToString , его поведение может оказаться нежелательным и нужно изменить его.Because a type inherits the default Object.ToString method, you may find its behavior undesirable and want to change it. Это особенно справедливо для массивов и классов коллекций.This is particularly true of arrays and collection classes. Несмотря на то, что ToString метод массива или класса коллекции может отображать значения его членов, вместо него отображается полное имя типа, как показано в следующем примере.While you may expect the ToString method of an array or collection class to display the values of its members, it instead displays the type fully qualified type name, as the following example shows.

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]

Есть несколько вариантов для создания результирующей строки, которая вам нужна.You have several options to produce the result string that you'd like.

  • Если тип IEnumerable является массивом, объектом коллекции или объектом, реализующим интерфейсы или IEnumerable<T> , можно перечислить foreach его элементы с помощью инструкции в C# или For Each...Next конструкции в Visual Basic.If the type is an array, a collection object, or an object that implements the IEnumerable or IEnumerable<T> interfaces, you can enumerate its elements by using the foreach statement in C# or the For Each...Next construct in Visual Basic.

  • Если класс sealed не является (in C#) или NotInheritable (в Visual Basic), можно разработать класс-оболочку, который Object.ToString наследует от базового класса, метод которого необходимо настроить.If the class is not sealed (in C#) or NotInheritable (in Visual Basic), you can develop a wrapper class that inherits from the base class whose Object.ToString method you want to customize. Как минимум, для этого необходимо выполнить следующие действия.At a minimum, this requires that you do the following:

    1. Реализуйте все необходимые конструкторы.Implement any necessary constructors. Производные классы не наследуют конструкторы базовых классов.Derived classes do not inherit their base class constructors.

    2. Переопределите Object.ToString метод, чтобы вернуть результирующую строку, которая вам нужна.Override the Object.ToString method to return the result string that you'd like.

    В следующем примере определяется класс-оболочка для List<T> класса.The following example defines a wrapper class for the List<T> class. Он переопределяет Object.ToString метод для вывода значения каждого метода коллекции, а не полного имени типа.It overrides the Object.ToString method to display the value of each method of the collection rather than the fully qualified type name.

    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
    
  • Разрабатывайте метод расширения , который возвращает нужную результирующую строку.Develop an extension method that returns the result string that you want. Обратите внимание, что метод по Object.ToString умолчанию нельзя переопределить таким образом (т. е. класс расширения C#(в) или модуль (в Visual Basic) не может иметь метод без ToString параметров именования, который вызывается вместо исходного типа ToStringметод.Note that you can't override the default Object.ToString method in this way (that is, your extension class (in C#) or module (in Visual Basic) cannot have a parameterless method named ToString that is called in place of the original type's ToString method. Вам потребуется указать другое имя для ToString замены без параметров.You'll have to provide some other name for your parameterless ToString replacement.

    В List<T> следующем примере определяются два метода, расширяющие класс: ToString2 метод без параметров, String а также ToString метод с параметром, представляющим строку формата.The following example defines two methods that extend the List<T> class: a parameterless ToString2 method, and a ToString method with a String parameter that represents a format 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 }
    

Примечания дляСреда выполнения WindowsWindows RuntimeNotes for the Среда выполнения WindowsWindows Runtime

При вызове ToString метода класса Среда выполнения WindowsWindows Runtimeв он предоставляет поведение по умолчанию для классов, которые не переопределяются ToString.When you call the ToString method on a class in the Среда выполнения WindowsWindows Runtime, it provides the default behavior for classes that don't override ToString. Это является частью поддержки, предоставляемой .NET Framework для Среда выполнения WindowsWindows Runtime (см. раздел поддержка .NET Framework для приложений Магазина Windows и среда выполнения Windows).This is part of the support that the .NET Framework provides for the Среда выполнения WindowsWindows Runtime (see .NET Framework Support for Windows Store Apps and Windows Runtime). Классы в Среда выполнения WindowsWindows Runtime классе не наследуют Object ToStringи не всегда реализуют.Classes in the Среда выполнения WindowsWindows Runtime don't inherit Object, and don't always implement a ToString. Однако ToStringони всегда имеют методы, Equals(Object)и GetHashCode при их использовании в коде C# или Visual Basic, а .NET Framework предоставляет поведение по умолчанию для этих методов.However, they always appear to have ToString, Equals(Object), and GetHashCode methods when you use them in your C# or Visual Basic code, and the .NET Framework provides a default behavior for these methods.

Начиная с .NET Framework 4.5.1.NET Framework 4.5.1, среда CLR будет использовать IStringable. Среда выполнения WindowsWindows Runtime ToString для объекта, прежде чем вернуться к реализации Object.ToStringпо умолчанию.Starting with the .NET Framework 4.5.1.NET Framework 4.5.1, the common language runtime will use IStringable.ToString on a Среда выполнения WindowsWindows Runtime object before falling back to the default implementation of Object.ToString.

Примечание

Среда выполнения WindowsWindows Runtimeклассы, написанные на C# языке или Visual Basic могут переопределять ToString метод.classes that are written in C# or Visual Basic can override the ToString method.

Интерфейс Среда выполнения WindowsWindows Runtime и IStringableThe Среда выполнения WindowsWindows Runtime and the IStringable Interface

Начиная с Windows 8.1Windows 8.1 Object.ToString , компонент включаетинтерфейсIStringable,единственныйметодкоторогоIStringable.ToStringобеспечиваетбазовуюподдержкуформатированияСреда выполнения WindowsWindows Runtime , сравнимую с, обеспечиваемую.Starting with Windows 8.1Windows 8.1, the Среда выполнения WindowsWindows Runtime includes an IStringable interface whose single method, IStringable.ToString, provides basic formatting support comparable to that provided by Object.ToString. Чтобы предотвратить неоднозначность, не следует реализовывать IStringable для управляемых типов.To prevent ambiguity, you should not implement IStringable on managed types.

Если управляемые объекты вызываются машинным кодом или кодом, написанным на языках, таких как C++JavaScript или/CX, они выглядят как реализующие IStringable.When managed objects are called by native code or by code written in languages such as JavaScript or C++/CX, they appear to implement IStringable. Среда CLR автоматически направит вызовы из IStringable. ToString Object.ToString в в случае, если событие IStringable не реализовано в управляемом объекте.The common language runtime will automatically route calls from IStringable.ToString to Object.ToString in the event IStringable is not implemented on the managed object.

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

Так как среда CLR Auto реализует IStringable для всех управляемых типов в Магазин WindowsWindows Store приложениях, рекомендуется не предоставлять собственную реализацию IStringable .Because the common language runtime auto-implements IStringable for all managed types in Магазин WindowsWindows Store apps, we recommend that you do not provide your own IStringable implementation. Реализация IStringable может привести к непредвиденному поведению при ToString вызове Среда выполнения WindowsWindows Runtimeиз C++,/CX или JavaScript.Implementing IStringable may result in unintended behavior when calling ToString from the Среда выполнения WindowsWindows Runtime, C++/CX, or JavaScript.

Если вы решили реализовать IStringable в общедоступном управляемом типе, экспортированном в Среда выполнения WindowsWindows Runtime компоненте, применяются следующие ограничения.If you do choose to implement IStringable in a public managed type that is exported in a Среда выполнения WindowsWindows Runtime component, the following restrictions apply:

  • Интерфейс IStringable можно определить только в связи «класс реализует», напримерYou can define the IStringable interface only in a "class implements" relationship, such as

    public class NewClass : IStringable  
    

    в C# илиin C#, or

    Public Class NewClass : Implements IStringable  
    

    в Visual Basic.in Visual Basic.

  • Невозможно реализовать IStringable в интерфейсе.You cannot implement IStringable on an interface.

  • Нельзя объявить параметр типа IStringable.You cannot declare a parameter to be of type IStringable.

  • IStringable не может быть типом возвращаемого значения метода, свойства или поля.IStringable cannot be the return type of a method, property, or field.

  • Невозможно скрыть реализацию IStringable из базовых классов с помощью определения метода, как показано ниже:You cannot hide your IStringable implementation from base classes by using a method definition such as the following:

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

    Вместо этого реализация IStringable. ToString должна всегда переопределять реализацию базового класса.Instead, the IStringable.ToString implementation must always override the base class implementation. Реализацию ToString можно скрыть только путем вызова этого метода в строго типизированном экземпляре класса.You can hide a ToString implementation only by invoking it on a strongly typed class instance.

Обратите внимание, что при различных условиях вызовы из машинного кода в управляемый тип, реализующий IStringable или скрывая его реализацию ToString , могут привести к непредвиденному поведению.Note that under a variety of conditions, calls from native code to a managed type that implements IStringable or hides its ToString implementation can produce unexpected behavior.

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

При реализации собственных типов следует переопределить метод, чтобы он ToString() возвращал значения, имеющие смысл для этих типов.When you implement your own types, you should override the ToString() method to return values that are meaningful for those types. Производные классы, которым требуется больший контроль над ToString() форматированием, чем IFormattable предоставляет, могут реализовывать интерфейс.Derived classes that require more control over formatting than ToString() provides can implement the IFormattable interface. Его ToString(String, IFormatProvider) метод позволяет определять строки формата, управляющие форматированием, и IFormatProvider использовать объект, который может обеспечить форматирование для определенного языка и региональных параметров.Its ToString(String, IFormatProvider) method enables you to define format strings that control formatting and to use an IFormatProvider object that can provide for culture-specific formatting.

ToString() Переопределения метода должны соответствовать следующим рекомендациям:Overrides of the ToString() method should follow these guidelines: — Возвращаемая строка должна быть понятной и удобочитаемой для людей.- The returned string should be friendly and readable by humans.

— Возвращаемая строка должна уникальным образом идентифицировать значение экземпляра объекта.- The returned string should uniquely identify the value of the object instance.

-Возвращаемая строка должна быть максимально короткой, чтобы ее можно было отображать с помощью отладчика.- The returned string should be as short as possible so that it is suitable for display by a debugger.

-Переопределение не должно возвращать Empty строку или значение null. ToString()- Your ToString() override should not return Empty or a null string.

ToString() -Переопределение не должно вызывать исключение.- Your ToString() override should not throw an exception.

— Если строковое представление экземпляра зависит от языка и региональных параметров или может быть отформатировано несколькими способами, реализуйте IFormattable интерфейс.- If the string representation of an instance is culture-sensitive or can be formatted in multiple ways, implement the IFormattable interface.

— Если возвращаемая строка содержит конфиденциальную информацию, необходимо сначала запросить соответствующее разрешение.- If the returned string includes sensitive information, you should first demand an appropriate permission. Если запрос проходит удачно, вы можете вернуть конфиденциальную информацию. в противном случае следует вернуть строку, которая исключается из конфиденциальной информации.If the demand succeeds, you can return the sensitive information; otherwise, you should return a string that excludes the sensitive information.

ToString() -Переопределение не должно иметь наблюдаемых побочных эффектов, чтобы избежать сложностей при отладке.- Your ToString() override should have no observable side effects to avoid complications in debugging. Например, вызов ToString() метода не должен изменять значение полей экземпляра.For example, a call to the ToString() method should not change the value of instance fields.

— Если тип реализует метод синтаксического анализа (или Parse TryParse метод, конструктор или какой-либо другой статический метод, который создает экземпляр типа из строки), следует убедиться, что строка, возвращаемая ToString() методом, может быть преобразуется в экземпляр объекта.- If your type implements a parsing method (or Parse or TryParse method, a constructor, or some other static method that instantiates an instance of the type from a string), you should ensure that the string returned by the ToString() method can be converted to an object instance.

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

Дополнительно