IFormattable 인터페이스

정의

개체의 값을 문자열 표현으로 서식 지정하는 기능을 제공합니다.Provides functionality to format the value of an object into a string representation.

public interface class IFormattable
[System.Runtime.InteropServices.ComVisible(true)]
public interface IFormattable
type IFormattable = interface
Public Interface IFormattable
파생
특성

예제

다음 예제에서는 Temperature 인터페이스를 구현하는 IFormattable 클래스를 정의합니다.The following example defines a Temperature class that implements the IFormattable interface. 이 클래스는 4 명의 형식 지정 자가 지원: 온도 섭씨;에 표시 되는 여부를 나타내는 "G" 및 "C" "F" 온도를 화씨로; 표시할 임을 나타냅니다 및 "K" 온도를 켈빈 표시할 임을 나타냅니다.The class supports four format specifiers: "G" and "C", which indicate that the temperature is to be displayed in Celsius; "F", which indicates that the temperature is to be displayed in Fahrenheit; and "K", which indicates that the temperature is to be displayed in Kelvin. 또한 합니다 IFormattable.ToString 구현도 처리할 수는 서식 문자열입니다 null 이거나 비어 있습니다.In addition, the IFormattable.ToString implementation also can handle a format string that is null or empty. 다른 두 ToString 정의한 메서드를 Temperature 클래스는 호출을 래핑하는 IFormattable.ToString 구현 합니다.The other two ToString methods defined by the Temperature class simply wrap a call to the IFormattable.ToString implementation.

using System;
using System.Globalization;

public class Temperature : IFormattable
{
   private decimal temp;
   
   public Temperature(decimal temperature)
   {
      if (temperature < -273.15m) 
        throw new ArgumentOutOfRangeException(String.Format("{0} is less than absolute zero.", 
                                              temperature));
      this.temp = temperature;
   }
   
   public decimal Celsius
   {
      get { return temp; }
   }
   
   public decimal Fahrenheit
   {
      get { return temp * 9 / 5 + 32; }
   }
   
   public decimal Kelvin
   {
      get { return temp + 273.15m; }
   }

   public override string ToString()
   {
      return this.ToString("G", CultureInfo.CurrentCulture);
   }
      
   public string ToString(string format)
   {
      return this.ToString(format, CultureInfo.CurrentCulture);
   }
   
   public string ToString(string format, IFormatProvider provider) 
   {
      if (String.IsNullOrEmpty(format)) format = "G";
      if (provider == null) provider = CultureInfo.CurrentCulture;
      
      switch (format.ToUpperInvariant())
      {
         case "G":
         case "C":
            return temp.ToString("F2", provider) + " °C"; 
         case "F":
            return Fahrenheit.ToString("F2", provider) + " °F";
         case "K":
            return Kelvin.ToString("F2", provider) + " K";
         default:
            throw new FormatException(String.Format("The {0} format string is not supported.", format));
      }
   }
}
Imports System.Globalization

Public Class Temperature : Implements IFormattable
   Private temp As Decimal
   
   Public Sub New(temperature As Decimal)
      If temperature < -273.15 Then _ 
        Throw New ArgumentOutOfRangeException(String.Format("{0} is less than absolute zero.", _
                                              temperature))
      Me.temp = temperature
   End Sub
   
   Public ReadOnly Property Celsius As Decimal
      Get
         Return temp
      End Get
   End Property
   
   Public ReadOnly Property Fahrenheit As Decimal
      Get
         Return temp * 9 / 5 + 32
      End Get
   End Property
   
   Public ReadOnly Property Kelvin As Decimal
      Get
         Return temp + 273.15d
      End Get
   End Property

   Public Overrides Function ToString() As String
      Return Me.ToString("G", CultureInfo.CurrentCulture)
   End Function
      
   Public Overloads Function ToString(fmt As String) As String
      Return Me.ToString(fmt, CultureInfo.CurrentCulture)
   End Function
   
   Public Overloads Function ToString(fmt As String, provider As IFormatProvider) _
                   As String _
                   Implements IFormattable.ToString
      If String.IsNullOrEmpty(fmt) Then fmt = "G"
      If provider Is Nothing Then provider = CultureInfo.CurrentCulture
      
      Select Case fmt.ToUpperInvariant()
         Case "G", "C"
            Return temp.ToString("F2", provider) + " °C" 
         Case "F"
            Return Fahrenheit.ToString("F2", provider) + " °F"
         Case "K"
            Return Kelvin.ToString("F2", provider) + " K"
         Case Else
            Throw New FormatException(String.Format("The {0} format string is not supported.", fmt))
      End Select
   End Function
End Class

다음 예제에서는 호출을 IFormattable.ToString 구현을 직접 또는 합성 서식 문자열을 사용 하 여 합니다.The following example then calls the IFormattable.ToString implementation either directly or by using a composite format string.

public class Example
{
   public static void Main()
   {
      // Use composite formatting with format string in the format item.
      Temperature temp1 = new Temperature(0);
      Console.WriteLine("{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)\n", temp1);
      
      // Use composite formatting with a format provider.
      temp1 = new Temperature(-40);
      Console.WriteLine(String.Format(CultureInfo.CurrentCulture, "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)", temp1));
      Console.WriteLine(String.Format(new CultureInfo("fr-FR"), "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)\n", temp1));
      
      // Call ToString method with format string.
      temp1 = new Temperature(32);
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)\n", 
                        temp1.ToString("C"), temp1.ToString("K"), temp1.ToString("F"));

      // Call ToString with format string and format provider
      temp1 = new Temperature(100)      ;
      NumberFormatInfo current = NumberFormatInfo.CurrentInfo;
      CultureInfo nl = new CultureInfo("nl-NL"); 
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", 
                        temp1.ToString("C", current), temp1.ToString("K", current), temp1.ToString("F", current));
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", 
                        temp1.ToString("C", nl), temp1.ToString("K", nl), temp1.ToString("F", nl));
   }
}
// The example displays the following output:
//    0.00 °C (Celsius) = 273.15 K (Kelvin) = 32.00 °F (Fahrenheit)
//    
//    -40.00 °C (Celsius) = 233.15 K (Kelvin) = -40.00 °F (Fahrenheit)
//    -40,00 °C (Celsius) = 233,15 K (Kelvin) = -40,00 °F (Fahrenheit)
//    
//    32.00 °C (Celsius) = 305.15 K (Kelvin) = 89.60 °F (Fahrenheit)
//    
//    100.00 °C (Celsius) = 373.15 K (Kelvin) = 212.00 °F (Fahrenheit)
//    100,00 °C (Celsius) = 373,15 K (Kelvin) = 212,00 °F (Fahrenheit)
Module Example
   Public Sub Main()
      ' Use composite formatting with format string in the format item.
      Dim temp1 As New Temperature(0)
      Console.WriteLine("{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)", temp1)
      Console.WriteLine()
      
      ' Use composite formatting with a format provider.
      temp1 = New Temperature(-40)
      Console.WriteLine(String.Format(CultureInfo.CurrentCulture, "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)", temp1))
      Console.WriteLine(String.Format(New CultureInfo("fr-FR"), "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)", temp1))
      Console.WriteLine()
      
      ' Call ToString method with format string.
      temp1 = New Temperature(32)
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", _
                        temp1.ToString("C"), temp1.ToString("K"), temp1.ToString("F"))
      Console.WriteLine()

      ' Call ToString with format string and format provider
      temp1 = New Temperature(100)      
      Dim current As NumberFormatInfo = NumberFormatInfo.CurrentInfo
      Dim nl As New CultureInfo("nl-NL") 
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", _
                        temp1.ToString("C", current), temp1.ToString("K", current), temp1.ToString("F", current))
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", _
                        temp1.ToString("C", nl), temp1.ToString("K", nl), temp1.ToString("F", nl))
   End Sub
End Module
' The example displays the following output:
'       0.00 °C (Celsius) = 273.15 K (Kelvin) = 32.00 °F (Fahrenheit)
'       
'       -40.00 °C (Celsius) = 233.15 K (Kelvin) = -40.00 °F (Fahrenheit)
'       -40,00 °C (Celsius) = 233,15 K (Kelvin) = -40,00 °F (Fahrenheit)
'       
'       32.00 °C (Celsius) = 305.15 K (Kelvin) = 89.60 °F (Fahrenheit)
'       
'       100.00 °C (Celsius) = 373.15 K (Kelvin) = 212.00 °F (Fahrenheit)
'       100,00 °C (Celsius) = 373,15 K (Kelvin) = 212,00 °F (Fahrenheit)

설명

IFormattable 인터페이스 개체는 형식 문자열과 형식 공급자에 따라 해당 문자열 표현으로 변환 합니다.The IFormattable interface converts an object to its string representation based on a format string and a format provider.

형식 문자열에는 일반적으로 개체의 전반적인 모양은 정의합니다.A format string typically defines the general appearance of an object. 예를 들어 다음.NET Framework를 지원합니다.For example, the .NET Framework supports the following:

또한 애플리케이션 정의 형식의 서식 지정을 지원 하기 위해 사용자 고유의 형식 문자열을 정의할 수 있습니다.You can also define your own format strings to support formatting of your application-defined types.

형식 공급자는 일반적으로 개체를 문자열 표현으로 변환할 때 사용 되는 기호를 정의 하는 서식 지정 개체를 반환 합니다.A format provider returns a formatting object that typically defines the symbols used in converting an object to its string representation. 예를 들어 통화 값을 숫자로 변환할 때 형식 공급자는 결과 문자열에 표시 되는 통화 기호를 정의 합니다.For example, when you convert a number to a currency value, a format provider defines the currency symbol that appears in the result string. .NET Framework는 세 가지 형식 공급자를 정의합니다.The .NET Framework defines three format providers:

또한 문화권별, 직업 별로 제공할 사용자 고유의 사용자 지정 형식 공급자를 정의할 수 있습니다 또는 산업별 정보 서식 지정에 사용 합니다.In addition, you can define your own custom format providers to supply culture-specific, profession-specific, or industry-specific information used in formatting. 사용자 지정 형식 공급자를 사용 하 여 사용자 지정 서식을 구현 하는 방법에 대 한 자세한 내용은 참조 하세요. ICustomFormatter합니다.For more information about implementing custom formatting by using a custom format provider, see ICustomFormatter.

합니다 IFormattable 는 단일 메서드를 정의 하는 인터페이스 ToString를 구현 하는 형식에 대 한 서식 지정 서비스를 제공 하는 합니다.The IFormattable interface defines a single method, ToString, that supplies formatting services for the implementing type. ToString 메서드를 직접 호출할 수 있습니다.The ToString method can be called directly. 또한 라고 자동으로 Convert.ToString(Object)Convert.ToString(Object, IFormatProvider) 메서드 및 사용 하는 방법으로는 복합 서식 지정 기능 .NET Framework에서.In addition, it is called automatically by the Convert.ToString(Object) and Convert.ToString(Object, IFormatProvider) methods, and by methods that use the composite formatting feature in the .NET Framework. 이러한 메서드를 포함 Console.WriteLine(String, Object), String.Format, 및 StringBuilder.AppendFormat(String, Object), 특히 합니다.Such methods include Console.WriteLine(String, Object), String.Format, and StringBuilder.AppendFormat(String, Object), among others. ToString 메서드의 형식 문자열의 각 서식 항목에 대 한 호출 됩니다.The ToString method is called for each format item in the method's format string.

IFormattable 인터페이스는 기본 데이터 형식으로 구현 됩니다.The IFormattable interface is implemented by the base data types.

구현자 참고

보다는 문자열의 서식을 제어할 필요가 있는 클래스 ToString() 제공 구현 해야 IFormattable합니다.Classes that require more control over the formatting of strings than ToString() provides should implement IFormattable.

구현 하는 클래스 IFormattable "G" (일반) 서식 지정자를 지원 해야 합니다.A class that implements IFormattable must support the "G" (general) format specifier. "G" 지정자 외 클래스 목록은 지원 되는 형식 지정자를 정의할 수 있습니다.Besides the "G" specifier, the class can define the list of format specifiers that it supports. 클래스는 형식 지정자를 처리 하도록 준비 해야 합니다 또한 null합니다.In addition, the class must be prepared to handle a format specifier that is null. 서식 지정 및 코드 서식 지정에 대 한 자세한 내용은 참조 하세요. 형식For more information about formatting and formatting codes, see Formatting Types

메서드

ToString(String, IFormatProvider)

지정된 형식을 사용하여 현재 인스턴스 값의 형식을 지정합니다.Formats the value of the current instance using the specified format.

적용 대상

추가 정보