System.Object.ToString yöntemi
Bu makale, bu API'nin başvuru belgelerine ek açıklamalar sağlar.
Object.ToString .NET'te yaygın bir biçimlendirme yöntemidir. Görüntülemeye uygun olması için bir nesneyi dize gösterimine dönüştürür. (.NET'te biçimlendirme desteği hakkında bilgi için bkz. Biçimlendirme Türleri.) yönteminin Object.ToString varsayılan uygulamaları nesne türünün tam adını döndürür.
Önemli
Başka bir türdeki üye listesinden bağlantıyı izleyerek bu sayfaya ulaşmış olabilirsiniz. Bunun nedeni, bu türün öğesini geçersiz kılmamasıdır Object.ToString. Bunun yerine yönteminin işlevselliğini devralır Object.ToString .
Türler, belirli bir türün Object.ToString daha uygun dize gösterimini sağlamak için yöntemini sıklıkla geçersiz kılar. Türler ayrıca biçim dizeleri veya kültüre duyarlı biçimlendirme desteği sağlamak için yöntemi sık sık aşırı yükler Object.ToString .
Varsayılan Object.ToString() yöntemi
Yönteminin ToString varsayılan uygulaması, aşağıdaki örnekte gösterildiği gibi türünün Objecttam adını döndürür.
Object obj = new Object();
Console.WriteLine(obj.ToString());
// The example displays the following output:
// System.Object
let obj = obj ()
printfn $"{obj.ToString()}"
// printfn $"{obj}" // Equivalent
// The example displays the following output:
// System.Object
Module Example3
Public Sub Main()
Dim obj As New Object()
Console.WriteLine(obj.ToString())
End Sub
End Module
' The example displays the following output:
' System.Object
Object.NET'teki tüm başvuru türlerinin temel sınıfı olduğundan, bu davranış yöntemini geçersiz kılmayan başvuru türleri tarafından devralınırToString. Aşağıdaki örnek bunu göstermektedir. Tüm Object üyelerin varsayılan uygulamasını kabul eden adlı Object1
bir sınıf tanımlar. Yöntemi ToString , nesnenin tam tür adını döndürür.
using System;
using Examples;
namespace Examples
{
public class Object1
{
}
}
public class Example5
{
public static void Main()
{
object obj1 = new Object1();
Console.WriteLine(obj1.ToString());
}
}
// The example displays the following output:
// Examples.Object1
type Object1() = class end
let obj1 = Object1()
printfn $"{obj1.ToString()}"
// The example displays the following output:
// Examples.Object1
Public Class Object1
End Class
Module Example4
Public Sub Main()
Dim obj1 As New Object1()
Console.WriteLine(obj1.ToString())
End Sub
End Module
' The example displays the following output:
' Examples.Object1
Object.ToString() yöntemini geçersiz kılma
Türler genellikle nesne örneğini Object.ToString temsil eden bir dize döndürmek için yöntemini geçersiz kılar. Örneğin, , ve gibi Chartemel türler, nesnenin temsil ettiği değerin dize biçimini döndüren uygulamalar sağlarToString.StringInt32 Aşağıdaki örnek, Object2
türün adını ve değerini döndürmek için yöntemini geçersiz kılan ToString bir sınıfı tanımlar.
using System;
public class Object2
{
private object value;
public Object2(object value)
{
this.value = value;
}
public override string ToString()
{
return base.ToString() + ": " + value.ToString();
}
}
public class Example6
{
public static void Main()
{
Object2 obj2 = new Object2('a');
Console.WriteLine(obj2.ToString());
}
}
// The example displays the following output:
// Object2: a
type Object2(value: obj) =
inherit obj ()
override _.ToString() =
base.ToString() + ": " + value.ToString()
let obj2 = Object2 'a'
printfn $"{obj2.ToString()}"
// The example displays the following output:
// Object2: a
Public Class Object2
Private value As Object
Public Sub New(value As Object)
Me.value = value
End Sub
Public Overrides Function ToString() As String
Return MyBase.ToString + ": " + value.ToString()
End Function
End Class
Module Example5
Public Sub Main()
Dim obj2 As New Object2("a"c)
Console.WriteLine(obj2.ToString())
End Sub
End Module
' The example displays the following output:
' Object2: a
Aşağıdaki tabloda .NET'teki tür kategorileri listelenerek yöntemi geçersiz kılıp geçersiz kılmadıkları Object.ToString gösterilir.
Tür kategorisi | Object.ToString() Geçersiz Kılar | Davranış |
---|---|---|
Sınıf | yok | yok |
Yapı | Evet (ValueType.ToString) | Aynı Object.ToString() |
Listeleme | Evet (Enum.ToString()) | Üye adı |
Arabirim | Hayır | yok |
Temsilci | Hayır | yok |
geçersiz kılma ToStringhakkında ek bilgi için Devralıcılara Notlar bölümüne bakın.
ToString yöntemini aşırı yükleme
Parametresiz Object.ToString() yöntemi geçersiz kılmaya ek olarak, birçok tür parametre kabul eden yöntemin sürümlerini sağlamak için yöntemini aşırı yükler ToString
. En yaygın olarak, bu, değişken biçimlendirme ve kültüre duyarlı biçimlendirme desteği sağlamak için yapılır.
Aşağıdaki örnek, bir sınıfın ToString
çeşitli alanlarının Automobile
değerini içeren bir sonuç dizesi döndürmek için yöntemini aşırı yükler. Dört biçim dizesini tanımlar: Model adını ve yılı döndüren G; Model adını, yılını ve kapı sayısını döndüren D; Model adını, yılını ve silindir sayısını döndüren C; ve dört alan değerinin tümünü içeren bir dize döndüren 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 Example7
{
public static void Main()
{
var auto = new Automobile("Lynx", 2016, 4, "V8");
Console.WriteLine(auto.ToString());
Console.WriteLine(auto.ToString("A"));
}
}
// The example displays the following output:
// 2016 Lynx
// 2016 Lynx, 4 dr. V8
open System
type Automobile(model: string, year: int, doors: int, cylinders: string) =
member _.Doors = doors
member _.Model = model
member _.Year = year
member _.Cylinders = cylinders
override this.ToString() =
this.ToString "G"
member _.ToString(fmt) =
let fmt =
if String.IsNullOrEmpty fmt then "G"
else fmt.ToUpperInvariant()
match fmt with
| "G" ->
$"{year} {model}"
| "D" ->
$"{year} {model}, {doors} dr."
| "C" ->
$"{year} {model}, {cylinders}"
| "A" ->
$"{year} {model}, {doors} dr. {cylinders}"
| _ ->
raise (ArgumentException $"'{fmt}' is an invalid format string")
let auto = Automobile("Lynx", 2016, 4, "V8")
printfn $"{auto}"
printfn $"""{auto.ToString "A"}"""
// The example displays the following output:
// 2016 Lynx
// 2016 Lynx, 4 dr. V8
Public Class Automobile
Private _doors As Integer
Private _cylinders As String
Private _year As Integer
Private _model As String
Public Sub New(model As String, year As Integer, doors As Integer,
cylinders As String)
_model = model
_year = year
_doors = doors
_cylinders = cylinders
End Sub
Public ReadOnly Property Doors As Integer
Get
Return _doors
End Get
End Property
Public ReadOnly Property Model As String
Get
Return _model
End Get
End Property
Public ReadOnly Property Year As Integer
Get
Return _year
End Get
End Property
Public ReadOnly Property Cylinders As String
Get
Return _cylinders
End Get
End Property
Public Overrides Function ToString() As String
Return ToString("G")
End Function
Public Overloads Function ToString(fmt As String) As String
If String.IsNullOrEmpty(fmt) Then fmt = "G"
Select Case fmt.ToUpperInvariant()
Case "G"
Return String.Format("{0} {1}", _year, _model)
Case "D"
Return String.Format("{0} {1}, {2} dr.",
_year, _model, _doors)
Case "C"
Return String.Format("{0} {1}, {2}",
_year, _model, _cylinders)
Case "A"
Return String.Format("{0} {1}, {2} dr. {3}",
_year, _model, _doors, _cylinders)
Case Else
Dim msg As String = String.Format("'{0}' is an invalid format string",
fmt)
Throw New ArgumentException(msg)
End Select
End Function
End Class
Module Example6
Public Sub Main()
Dim auto As New Automobile("Lynx", 2016, 4, "V8")
Console.WriteLine(auto.ToString())
Console.WriteLine(auto.ToString("A"))
End Sub
End Module
' The example displays the following output:
' 2016 Lynx
' 2016 Lynx, 4 dr. V8
Aşağıdaki örnek, bir para birimi değerinin kültüre duyarlı biçimlendirmesini görüntülemek için aşırı yüklenmiş Decimal.ToString(String, IFormatProvider) yöntemi çağırır.
using System;
using System.Globalization;
public class Example8
{
public static void Main()
{
string[] cultureNames = { "en-US", "en-GB", "fr-FR",
"hr-HR", "ja-JP" };
Decimal value = 1603.49m;
foreach (var cultureName in cultureNames) {
CultureInfo culture = new CultureInfo(cultureName);
Console.WriteLine("{0}: {1}", culture.Name,
value.ToString("C2", culture));
}
}
}
// The example displays the following output:
// en-US: $1,603.49
// en-GB: £1,603.49
// fr-FR: 1 603,49 €
// hr-HR: 1.603,49 kn
// ja-JP: ¥1,603.49
open System.Globalization
let cultureNames =
[| "en-US"; "en-GB"; "fr-FR"; "hr-HR"; "ja-JP" |]
let value = 1603.49m
for cultureName in cultureNames do
let culture = CultureInfo cultureName
printfn $"""{culture.Name}: {value.ToString("C2", culture)}"""
// The example displays the following output:
// en-US: $1,603.49
// en-GB: £1,603.49
// fr-FR: 1 603,49 €
// hr-HR: 1.603,49 kn
// ja-JP: ¥1,603.49
Imports System.Globalization
Module Example7
Public Sub Main()
Dim cultureNames() As String = {"en-US", "en-GB", "fr-FR",
"hr-HR", "ja-JP"}
Dim value As Decimal = 1603.49D
For Each cultureName In cultureNames
Dim culture As New CultureInfo(cultureName)
Console.WriteLine("{0}: {1}", culture.Name,
value.ToString("C2", culture))
Next
End Sub
End Module
' The example displays the following output:
' en-US: $1,603.49
' en-GB: £1,603.49
' fr-FR: 1 603,49 €
' hr-HR: 1.603,49 kn
' ja-JP: ¥1,603.49
Biçim dizeleri ve kültüre duyarlı biçimlendirme hakkında daha fazla bilgi için bkz . Biçimlendirme Türleri. Sayısal değerler tarafından desteklenen biçim dizeleri için bkz . Standart Sayısal Biçim Dizeleri ve Özel Sayısal Biçim Dizeleri. Tarih ve saat değerleri tarafından desteklenen biçim dizeleri için bkz . Standart Tarih ve Saat Biçim Dizeleri ve Özel Tarih ve Saat Biçim Dizeleri.
Object.ToString yöntemini genişletme
Bir tür varsayılan Object.ToString yöntemi devraldığından, davranışını istenmeyen bulabilir ve değiştirmek isteyebilirsiniz. Bu özellikle diziler ve koleksiyon sınıfları için geçerlidir. Bir dizi veya koleksiyon sınıfının yönteminin üyelerinin değerlerini görüntülemesini bekleyebilirsiniz ToString
ancak bunun yerine, aşağıdaki örnekte gösterildiği gibi türün tam tür adını görüntüler.
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]
İstediğiniz sonuç dizesini oluşturmak için çeşitli seçenekleriniz vardır.
Tür bir dizi, koleksiyon nesnesi veya arabirimlerini IEnumerableIEnumerable<T> uygulayan bir nesneyse, C# içindeki deyimini veya
For Each...Next
Visual Basic'teki yapısını kullanarakforeach
öğelerini numaralandırabilirsiniz.Sınıf (C#'da) veya
NotInheritable
(Visual Basic'te) değilsesealed
, yöntemini özelleştirmek istediğiniz temel sınıftan devralan bir sarmalayıcı sınıfı Object.ToString geliştirebilirsiniz. Bunun için en azından aşağıdakileri yapmanız gerekir:- Gerekli oluşturucuları uygulayın. Türetilmiş sınıflar temel sınıf oluşturucularını devralmaz.
- Object.ToString İstediğiniz sonuç dizesini döndürmek için yöntemini geçersiz kılın.
Aşağıdaki örnek, sınıfı için List<T> bir sarmalayıcı sınıfı tanımlar. Tam tür adı yerine koleksiyonun her yönteminin değerini görüntülemek için yöntemini geçersiz kılar 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 Example2 { public static void Main() { var list2 = new CList<int>(); list2.Add(1000); list2.Add(2000); Console.WriteLine(list2.ToString()); } } // The example displays the following output: // 1000, 2000
open System open System.Collections.Generic type CList<'T>() = inherit ResizeArray<'T>() override this.ToString() = let mutable retVal = String.Empty for item in this do if String.IsNullOrEmpty retVal then retVal <- retVal + string item else retVal <- retVal + $", {item}" retVal let list2 = CList() list2.Add 1000 list2.Add 2000 printfn $"{list2}" // The example displays the following output: // 1000, 2000
Imports System.Collections.Generic Public Class CList(Of T) : Inherits List(Of T) Public Sub New(capacity As Integer) MyBase.New(capacity) End Sub Public Sub New(collection As IEnumerable(Of T)) MyBase.New(collection) End Sub Public Sub New() MyBase.New() End Sub Public Overrides Function ToString() As String Dim retVal As String = String.Empty For Each item As T In Me If String.IsNullOrEmpty(retval) Then retVal += item.ToString() Else retval += String.Format(", {0}", item) End If Next Return retVal End Function End Class Module Example1 Public Sub Main() Dim list2 As New CList(Of Integer) list2.Add(1000) list2.Add(2000) Console.WriteLine(list2.ToString()) End Sub End Module ' The example displays the following output: ' 1000, 2000
İstediğiniz sonuç dizesini döndüren bir uzantı yöntemi geliştirin. Varsayılan Object.ToString yöntemi bu şekilde geçersiz kılamayacağınızı unutmayın; diğer bir deyişle, uzantı sınıfınızın (C#'ta) veya modülünüzde (Visual Basic'te) özgün türün
ToString
yöntemi yerine çağrılan parametresiz bir yöntemToString
olamaz. ParametresizToString
değişiminiz için başka bir ad sağlamanız gerekir.Aşağıdaki örnek, sınıfını genişleten List<T> iki yöntemi tanımlar: parametresiz
ToString2
bir yöntem veToString
biçim dizesini temsil eden parametresi olan bir String yöntem.using System; using System.Collections.Generic; public static class StringExtensions { public static string ToString2<T>(this List<T> l) { string retVal = string.Empty; foreach (T item in l) retVal += string.Format("{0}{1}", string.IsNullOrEmpty(retVal) ? "" : ", ", item); return string.IsNullOrEmpty(retVal) ? "{}" : "{ " + retVal + " }"; } public static string ToString<T>(this List<T> l, string fmt) { string retVal = string.Empty; foreach (T item in l) { IFormattable ifmt = item as IFormattable; if (ifmt != null) retVal += string.Format("{0}{1}", string.IsNullOrEmpty(retVal) ? "" : ", ", ifmt.ToString(fmt, null)); else retVal += ToString2(l); } return string.IsNullOrEmpty(retVal) ? "{}" : "{ " + retVal + " }"; } } public class Example3 { public static void Main() { List<int> list = new List<int>(); list.Add(1000); list.Add(2000); Console.WriteLine(list.ToString2()); Console.WriteLine(list.ToString("N0")); } } // The example displays the following output: // { 1000, 2000 } // { 1,000, 2,000 }
open System open System.Collections.Generic type List<'T> with member this.ToString2<'T>() = let mutable retVal = String.Empty for item in this do retVal <- retVal + $"""{if String.IsNullOrEmpty retVal then "" else ", "}{item}""" if String.IsNullOrEmpty retVal then "{}" else "{ " + retVal + " }" member this.ToString<'T>(fmt: string) = let mutable retVal = String.Empty for item in this do match box item with | :? IFormattable as ifmt -> retVal <- retVal + $"""{if String.IsNullOrEmpty retVal then "" else ", "}{ifmt.ToString(fmt, null)}""" | _ -> retVal <- retVal + this.ToString2() if String.IsNullOrEmpty retVal then "{}" else "{ " + retVal + " }" let list = ResizeArray() list.Add 1000 list.Add 2000 printfn $"{list.ToString2()}" printfn $"""{list.ToString "N0"}""" // The example displays the following output: // { 1000, 2000 } // { 1,000, 2,000 }
Imports System.Collections.Generic Imports System.Runtime.CompilerServices Public Module StringExtensions <Extension()> Public Function ToString2(Of T)(l As List(Of T)) As String Dim retVal As String = "" For Each item As T In l retVal += String.Format("{0}{1}", If(String.IsNullOrEmpty(retVal), "", ", "), item) Next Return If(String.IsNullOrEmpty(retVal), "{}", "{ " + retVal + " }") End Function <Extension()> Public Function ToString(Of T)(l As List(Of T), fmt As String) As String Dim retVal As String = String.Empty For Each item In l Dim ifmt As IFormattable = TryCast(item, IFormattable) If ifmt IsNot Nothing Then retVal += String.Format("{0}{1}", If(String.IsNullOrEmpty(retval), "", ", "), ifmt.ToString(fmt, Nothing)) Else retVal += ToString2(l) End If Next Return If(String.IsNullOrEmpty(retVal), "{}", "{ " + retVal + " }") End Function End Module Module Example2 Public Sub Main() Dim list As New List(Of Integer) list.Add(1000) list.Add(2000) Console.WriteLine(list.ToString2()) Console.WriteLine(list.ToString("N0")) End Sub End Module ' The example displays the following output: ' { 1000, 2000 } ' { 1,000, 2,000 }
Windows Çalışma Zamanı notları
Windows Çalışma Zamanı bir sınıfta yöntemini çağırdığınızdaToString, geçersiz kılma ToStringolmayan sınıflar için varsayılan davranışı sağlar. Bu, .NET'in Windows Çalışma Zamanı için sağladığı desteğin bir parçasıdır (bkz. Windows Mağazası Uygulamaları ve Windows Çalışma Zamanı için .NET Desteği). Windows Çalışma Zamanı sınıfları devralmaz Objectve her zaman bir ToStringuygulamaz. Ancak, C# veya Visual Basic kodunuzda kullandığınızda her zaman , Equals(Object)ve GetHashCode yöntemlerine sahip ToStringgibi görünürler ve .NET bu yöntemler için varsayılan bir davranış sağlar.
Ortak dil çalışma zamanı, varsayılan uygulamasına Object.ToStringgeri dönmeden önce Windows Çalışma Zamanı nesnede IStringable.ToString kullanır.
Not
C# veya Visual Basic ile yazılmış Windows Çalışma Zamanı sınıfları yöntemini geçersiz kılabilirToString.
Windows Çalışma Zamanı ve IStringable Arabirimi
Windows Çalışma Zamanı, tek yöntemi olan IStringable.ToString tarafından Object.ToStringsağlananla karşılaştırılabilir temel biçimlendirme desteği sağlayan bir IStringable arabirimi içerir. Belirsizliği önlemek için yönetilen türlerde IStringable uygulamamalısınız.
Yönetilen nesneler yerel kod veya JavaScript veya C++/CX gibi dillerde yazılmış kodlarla çağrıldığında, IStringable'ı uyguluyor gibi görünürler. Ortak dil çalışma zamanı, IStringable.ToString'den Object.ToString gelen çağrıları, yönetilen nesnede IStringable uygulanmamışsa otomatik olarak yönlendirir.
Uyarı
Ortak dil çalışma zamanı, Windows Mağazası uygulamalarındaki tüm yönetilen türler için IStringable'ı otomatik olarak uyguladığından, kendi IStringable
uygulamanızı sağlamamanızı öneririz. IStringable
Uygulama, Windows Çalışma Zamanı, C++/CX veya JavaScript'ten çağrı ToString
yapılırken istenmeyen davranışa neden olabilir.
IStringable'ı bir Windows Çalışma Zamanı bileşeninde dışarı aktarılan genel yönetilen bir türe uygulamayı seçerseniz, aşağıdaki kısıtlamalar geçerlidir:
IStringable arabirimini yalnızca "sınıf uygular" ilişkisinde aşağıdaki gibi tanımlayabilirsiniz:
public class NewClass : IStringable
Public Class NewClass : Implements IStringable
Bir arabirimde IStringable uygulayamazsınız.
IStringable türünde bir parametre bildiremezsiniz.
IStringable bir yöntemin, özelliğin veya alanın dönüş türü olamaz.
Aşağıdaki gibi bir yöntem tanımı kullanarak IStringable uygulamanızı temel sınıflardan gizleyemezsiniz:
public class NewClass : IStringable { public new string ToString() { return "New ToString in NewClass"; } }
Bunun yerine, IStringable.ToString uygulaması her zaman temel sınıf uygulamasını geçersiz kılmalıdır. Bir
ToString
uygulamayı yalnızca kesin olarak türü belirlenmiş bir sınıf örneğinde çağırarak gizleyebilirsiniz.
Çeşitli koşullar altında, yerel koddan IStringable uygulayan veya ToString uygulamasını gizleyen yönetilen bir türe yapılan çağrılar beklenmeyen davranışlara neden olabilir.