Object.ToString メソッド

定義

現在のオブジェクトを表す string を返します。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.

注意

この記事の C# 例の一部は、Try.NET インライン コード ランナーとプレイグラウンドで実行されます。Some of the C# examples in this article run in the Try.NET inline code runner and playground. [実行] ボタンがある場合は、これを選択して対話型ウィンドウで例を実行します。When present, select the Run button to run an example in an interactive window. コードを実行したら、コードを変更し、 [実行] をもう一度選択して変更後のコードを実行できます。Once you execute the code, you can modify it and run the modified code by selecting Run again. 変更後のコードが対話型ウィンドウで実行されるか、コンパイルできなかった場合、対話型ウィンドウにすべての C# コンパイラ エラー メッセージが表示されます。The modified code either runs in the interactive window or, if compilation fails, the interactive window displays all C# compiler error messages.

このセクションの内容In this section:

既定のオブジェクトの ToString () メソッド The default Object.ToString() method
オブジェクトの ToString () メソッドのオーバーライド Overriding the Object.ToString() method
ToString メソッドのオーバーロード Overloading the ToString method
オブジェクトの拡張メソッド Extending the Object.ToString method
Windows ランタイムのメモNotes for the Windows Runtime

既定のオブジェクトの 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. これは、すべての Object メンバーの既定の実装を受け入れる Object1 という名前のクラスを定義します。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

オブジェクトのオーバーライド () メソッドOverriding the Object.ToString() method

型は、通常、Object.ToString メソッドをオーバーライドして、オブジェクトインスタンスを表す文字列を返します。Types commonly override the Object.ToString method to return a string that represents the object instance. たとえば、CharInt32String などの基本型は、オブジェクトが表す値の文字列形式を返す 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/an/a n/an/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/an/a
デリゲートDelegate いいえNo n/an/a

ToStringのオーバーライドの詳細については、「継承に関する注意事項」を参照してください。See the Notes to Inheritors section for additional information on overriding ToString.

ToString メソッドのオーバーロードOverloading 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. 4つの書式指定文字列を定義します。 G は、モデル名と年を返します。D: モデル名、年、およびドアの数を返します。C: モデル名、年、およびシリンダーの数を返します。とは、4つのフィールド値すべてを含む文字列を返します。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.

オブジェクトの ToString メソッドの拡張Extending 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> インターフェイスを実装するオブジェクトである場合は、のC# foreach ステートメントまたは Visual Basic の For Each...Next コンストラクトを使用して、その要素を列挙できます。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 ( 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> クラスを拡張する2つのメソッドを定義しています。パラメーターなしの 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 }
    

Windows ランタイムWindows Runtime のメモNotes for the Windows ランタイムWindows Runtime

Windows ランタイムWindows Runtimeのクラスで ToString メソッドを呼び出すと、ToStringをオーバーライドしないクラスの既定の動作が提供されます。When you call the ToString method on a class in the Windows ランタイムWindows Runtime, it provides the default behavior for classes that don't override ToString. これは、.NET Framework が Windows ランタイムWindows Runtime に提供するサポートの一部です (「 Windows ストアアプリと Windows ランタイムの .NET Framework サポート」を参照してください)。This is part of the support that the .NET Framework provides for the Windows ランタイムWindows Runtime (see .NET Framework Support for Windows Store Apps and Windows Runtime). Windows ランタイムWindows Runtime のクラスは Objectを継承せず、常に ToStringを実装することはありません。Classes in the Windows ランタイムWindows Runtime don't inherit Object, and don't always implement a ToString. ただし、これらのメソッドをC#または Visual Basic コードで使用すると、これらのメソッドは常に ToStringEquals(Object)、および GetHashCode に表示されます。また、.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以降では、共通言語ランタイムは、Object.ToStringの既定の実装に戻る前に、Windows ランタイムWindows Runtime オブジェクトに対してIstringableを使用します。Starting with the .NET Framework 4.5.1.NET Framework 4.5.1, the common language runtime will use IStringable.ToString on a Windows ランタイムWindows Runtime object before falling back to the default implementation of Object.ToString.

注意

または Visual Basic でC#記述された Windows ランタイムWindows Runtime クラスは、ToString メソッドをオーバーライドできます。Windows ランタイムWindows Runtime classes that are written in C# or Visual Basic can override the ToString method.

Windows ランタイムWindows Runtime と IStringable インターフェイスThe Windows ランタイムWindows Runtime and the IStringable Interface

Windows 8.1Windows 8.1以降では、Windows ランタイムWindows Runtimeistringableインターフェイスが含まれています。このインターフェイスは、単一のメソッドであるistringableを使用して、Object.ToStringによって提供される基本的な書式設定のサポートを提供します。Starting with Windows 8.1Windows 8.1, the Windows ランタイムWindows 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.

マネージオブジェクトがネイティブコードまたは JavaScript やC++/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. 共通言語ランタイムは、 istringableからの呼び出しを、マネージオブジェクトに実装されていないイベントのObject.ToString に自動的にルーティングします。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.

警告

共通言語ランタイムは、Windows ストアWindows Store アプリのすべてのマネージ型に対してIstringableを自動的に実装するため、独自のistringableの実装を提供しないことをお勧めします。Because the common language runtime auto-implements IStringable for all managed types in Windows ストアWindows Store apps, we recommend that you do not provide your own IStringable implementation. Istringableを実装すると、Windows ランタイムWindows Runtime、 C++/Cx、または JavaScript から ToString を呼び出すときに意図しない動作が発生する可能性があります。Implementing IStringable may result in unintended behavior when calling ToString from the Windows ランタイムWindows Runtime, C++/CX, or JavaScript.

Windows ランタイムWindows Runtime コンポーネントにエクスポートされるパブリックマネージ型にIstringableを実装する場合は、次の制限が適用されます。If you do choose to implement IStringable in a public managed type that is exported in a Windows ランタイムWindows 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の実装では、常に基底クラスの実装をオーバーライドする必要があります。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.

-ToString() のオーバーライドは、Empty または null 文字列を返さないようにする必要があります。- 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.

適用対象

こちらもご覧ください