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
Возвращаемое значение
Строка, представляющая текущий объект.
Комментарии
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
let obj = obj ()
printfn $"{obj.ToString()}"
// printfn $"{obj}" // Equivalent
// The example displays the following output:
// System.Object
Module Example
Public Sub Main()
Dim obj As New Object()
Console.WriteLine(obj.ToString())
End Sub
End Module
' The example displays the following output:
' System.Object
Поскольку 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
type Object1() = class end
let obj1 = Object1()
printfn $"{obj1.ToString()}"
// The example displays the following output:
// Examples.Object1
Imports Examples
Namespace Examples
Public Class Object1
End Class
End Namespace
Module Example
Public Sub Main()
Dim obj1 As New Object1()
Console.WriteLine(obj1.ToString())
End Sub
End Module
' The example displays the following output:
' Examples.Object1
Переопределение метода 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
type Object2(value: obj) =
inherit obj ()
override _.ToString() =
base.ToString() + ": " + value.ToString()
let obj2 = Object2 'a'
printfn $"{obj2.ToString()}"
// The example displays the following output:
// Object2: a
Public Class Object2
Private value As Object
Public Sub New(value As Object)
Me.value = value
End Sub
Public Overrides Function ToString() As String
Return MyBase.ToString + ": " + value.ToString()
End Function
End Class
Module Example
Public Sub Main()
Dim obj2 As New Object2("a"c)
Console.WriteLine(obj2.ToString())
End Sub
End Module
' The example displays the following output:
' Object2: a
В следующей таблице перечислены категории типов в .NET и указано, переопределяют Object.ToString ли они метод .
Категория типа | Переопределяет Object.ToString() | Поведение |
---|---|---|
Класс | Недоступно | Недоступно |
structure | Да (ValueType.ToString) | То же, что Object.ToString() |
Перечисление | Да (Enum.ToString()) | Имя члена |
Интерфейс | нет | Недоступно |
Делегат | нет | Недоступно |
Дополнительные сведения о переопределении см. в разделе Примечания к наследующим ToString.
Перегрузка метода ToString
Помимо переопределения метода без Object.ToString() параметров, многие типы перегружают ToString
метод для предоставления версий метода, которые принимают параметры. Чаще всего это делается для поддержки форматирования переменных и форматирования с учетом языка и региональных параметров.
В следующем примере метод перегружается ToString
для возврата результирующих строк, включающих значения различных полей Automobile
класса . Он определяет четыре строки формата: G, которая возвращает имя модели и год; D, который возвращает имя модели, год и количество дверей; C, возвращающий имя модели, год и количество цилиндров; и A, который возвращает строку со всеми четырьмя значениями полей.
using System;
public class Automobile
{
private int _doors;
private string _cylinders;
private int _year;
private string _model;
public Automobile(string model, int year , int doors,
string cylinders)
{
_model = model;
_year = year;
_doors = doors;
_cylinders = cylinders;
}
public int Doors
{ get { return _doors; } }
public string Model
{ get { return _model; } }
public int Year
{ get { return _year; } }
public string Cylinders
{ get { return _cylinders; } }
public override string ToString()
{
return ToString("G");
}
public string ToString(string fmt)
{
if (string.IsNullOrEmpty(fmt))
fmt = "G";
switch (fmt.ToUpperInvariant())
{
case "G":
return string.Format("{0} {1}", _year, _model);
case "D":
return string.Format("{0} {1}, {2} dr.",
_year, _model, _doors);
case "C":
return string.Format("{0} {1}, {2}",
_year, _model, _cylinders);
case "A":
return string.Format("{0} {1}, {2} dr. {3}",
_year, _model, _doors, _cylinders);
default:
string msg = string.Format("'{0}' is an invalid format string",
fmt);
throw new ArgumentException(msg);
}
}
}
public class Example
{
public static void Main()
{
var auto = new Automobile("Lynx", 2016, 4, "V8");
Console.WriteLine(auto.ToString());
Console.WriteLine(auto.ToString("A"));
}
}
// The example displays the following output:
// 2016 Lynx
// 2016 Lynx, 4 dr. V8
open System
type Automobile(model: string, year: int, doors: int, cylinders: string) =
member _.Doors = doors
member _.Model = model
member _.Year = year
member _.Cylinders = cylinders
override this.ToString() =
this.ToString "G"
member _.ToString(fmt) =
let fmt =
if String.IsNullOrEmpty fmt then "G"
else fmt.ToUpperInvariant()
match fmt with
| "G" ->
$"{year} {model}"
| "D" ->
$"{year} {model}, {doors} dr."
| "C" ->
$"{year} {model}, {cylinders}"
| "A" ->
$"{year} {model}, {doors} dr. {cylinders}"
| _ ->
raise (ArgumentException $"'{fmt}' is an invalid format string")
let auto = Automobile("Lynx", 2016, 4, "V8")
printfn $"{auto}"
printfn $"""{auto.ToString "A"}"""
// The example displays the following output:
// 2016 Lynx
// 2016 Lynx, 4 dr. V8
Public Class Automobile
Private _doors As Integer
Private _cylinders As String
Private _year As Integer
Private _model As String
Public Sub New(model As String, year As Integer, doors As Integer,
cylinders As String)
_model = model
_year = year
_doors = doors
_cylinders = cylinders
End Sub
Public ReadOnly Property Doors As Integer
Get
Return _doors
End Get
End Property
Public ReadOnly Property Model As String
Get
Return _model
End Get
End Property
Public ReadOnly Property Year As Integer
Get
Return _year
End Get
End Property
Public ReadOnly Property Cylinders As String
Get
Return _cylinders
End Get
End Property
Public Overrides Function ToString() As String
Return ToString("G")
End Function
Public Overloads Function ToString(fmt As String) As String
If String.IsNullOrEmpty(fmt) Then fmt = "G"
Select Case fmt.ToUpperInvariant()
Case "G"
Return String.Format("{0} {1}", _year, _model)
Case "D"
Return String.Format("{0} {1}, {2} dr.",
_year, _model, _doors)
Case "C"
Return String.Format("{0} {1}, {2}",
_year, _model, _cylinders)
Case "A"
Return String.Format("{0} {1}, {2} dr. {3}",
_year, _model, _doors, _cylinders)
Case Else
Dim msg As String = String.Format("'{0}' is an invalid format string",
fmt)
Throw New ArgumentException(msg)
End Select
End Function
End Class
Module Example
Public Sub Main()
Dim auto As New Automobile("Lynx", 2016, 4, "V8")
Console.WriteLine(auto.ToString())
Console.WriteLine(auto.ToString("A"))
End Sub
End Module
' The example displays the following output:
' 2016 Lynx
' 2016 Lynx, 4 dr. V8
В следующем примере вызывается перегруженный 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
open System.Globalization
let cultureNames =
[| "en-US"; "en-GB"; "fr-FR"; "hr-HR"; "ja-JP" |]
let value = 1603.49m
for cultureName in cultureNames do
let culture = CultureInfo cultureName
printfn $"""{culture.Name}: {value.ToString("C2", culture)}"""
// The example displays the following output:
// en-US: $1,603.49
// en-GB: £1,603.49
// fr-FR: 1 603,49 €
// hr-HR: 1.603,49 kn
// ja-JP: ¥1,603.49
Imports System.Globalization
Module Example
Public Sub Main()
Dim cultureNames() As String = { "en-US", "en-GB", "fr-FR",
"hr-HR", "ja-JP" }
Dim value As Decimal = 1603.49d
For Each cultureName In cultureNames
Dim culture As New CultureInfo(cultureName)
Console.WriteLine("{0}: {1}", culture.Name,
value.ToString("C2", culture))
Next
End Sub
End Module
' The example displays the following output:
' en-US: $1,603.49
' en-GB: £1,603.49
' fr-FR: 1 603,49 €
' hr-HR: 1.603,49 kn
' ja-JP: ¥1,603.49
Дополнительные сведения о строках форматирования и форматировании с учетом языка и региональных параметров см. в разделе Типы форматирования. Строки форматирования, поддерживаемые числовыми значениями, см. в разделах Строки стандартного числового формата и Строки пользовательского числового формата. Строки форматирования, поддерживаемые значениями даты и времени, см. в разделах Стандартные строки формата даты и времени и Настраиваемые строки формата даты и времени.
Расширение метода 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]
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]
У вас есть несколько вариантов создания нужной результирующих строк.
Если типом является массив, объект коллекции или объект, реализующий IEnumerable интерфейсы или IEnumerable<T> , можно перечислить его элементы с помощью
foreach
инструкции в C# илиFor Each...Next
конструкции в Visual Basic.Если класс не
sealed
является (в C#) илиNotInheritable
(в Visual Basic), можно разработать класс-оболочку, который наследуется от базового класса, метод которого Object.ToString требуется настроить. Для этого требуется как минимум следующее:Реализуйте все необходимые конструкторы. Производные классы не наследуют конструкторы базовых классов.
Переопределите 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
open System open System.Collections.Generic type CList<'T>() = inherit ResizeArray<'T>() override this.ToString() = let mutable retVal = String.Empty for item in this do if String.IsNullOrEmpty retVal then retVal <- retVal + string item else retVal <- retVal + $", {item}" retVal let list2 = CList() list2.Add 1000 list2.Add 2000 printfn $"{list2}" // The example displays the following output: // 1000, 2000
Imports System.Collections.Generic Public Class CList(Of T) : Inherits List(Of T) Public Sub New(capacity As Integer) MyBase.New(capacity) End Sub Public Sub New(collection As IEnumerable(Of T)) MyBase.New(collection) End Sub Public Sub New() MyBase.New() End Sub Public Overrides Function ToString() As String Dim retVal As String = String.Empty For Each item As T In Me If String.IsNullOrEmpty(retval) Then retVal += item.ToString() Else retval += String.Format(", {0}", item) End If Next Return retVal End Function End Class Module Example Public Sub Main() Dim list2 As New CList(Of Integer) list2.Add(1000) list2.Add(2000) Console.WriteLine(list2.ToString()) End Sub End Module ' The example displays the following output: ' 1000, 2000
Разработайте метод расширения , который возвращает нужную результирующую строку. Обратите внимание, что таким образом нельзя переопределить метод по умолчанию 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 }
open System open System.Collections.Generic type List<'T> with member this.ToString2<'T>() = let mutable retVal = String.Empty for item in this do retVal <- retVal + $"""{if String.IsNullOrEmpty retVal then "" else ", "}{item}""" if String.IsNullOrEmpty retVal then "{}" else "{ " + retVal + " }" member this.ToString<'T>(fmt: string) = let mutable retVal = String.Empty for item in this do match box item with | :? IFormattable as ifmt -> retVal <- retVal + $"""{if String.IsNullOrEmpty retVal then "" else ", "}{ifmt.ToString(fmt, null)}""" | _ -> retVal <- retVal + this.ToString2() if String.IsNullOrEmpty retVal then "{}" else "{ " + retVal + " }" let list = ResizeArray() list.Add 1000 list.Add 2000 printfn $"{list.ToString2()}" printfn $"""{list.ToString "N0"}""" // The example displays the following output: // { 1000, 2000 } // { 1,000, 2,000 }
Imports System.Collections.Generic Imports System.Runtime.CompilerServices Public Module StringExtensions <Extension()> Public Function ToString2(Of T)(l As List(Of T)) As String Dim retVal As String = "" For Each item As T In l retVal += String.Format("{0}{1}", If(String.IsNullOrEmpty(retVal), "", ", "), item) Next Return If(String.IsNullOrEmpty(retVal), "{}", "{ " + retVal + " }") End Function <Extension()> Public Function ToString(Of T)(l As List(Of T), fmt As String) As String Dim retVal As String = String.Empty For Each item In l Dim ifmt As IFormattable = TryCast(item, IFormattable) If ifmt IsNot Nothing Then retVal += String.Format("{0}{1}", If(String.IsNullOrEmpty(retval), "", ", "), ifmt.ToString(fmt, Nothing)) Else retVal += ToString2(l) End If Next Return If(String.IsNullOrEmpty(retVal), "{}", "{ " + retVal + " }") End Function End Module Module Example Public Sub Main() Dim list As New List(Of Integer) list.Add(1000) list.Add(2000) Console.WriteLine(list.ToString2()) Console.WriteLine(list.ToString("N0")) End Sub End Module ' The example displays the following output: ' { 1000, 2000 } ' { 1,000, 2,000 }
Примечания для среда выполнения 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 автоматически реализует IStringable для всех управляемых типов в приложениях Магазина Windows, рекомендуется не предоставлять собственную 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() , может быть преобразована в экземпляр объекта.