Baca dalam bahasa Inggris

Bagikan melalui

IFormattable Antarmuka

  • Referensi

Definisi

Ruang nama:
System
Rakitan:
System.Runtime.dll
Rakitan:
mscorlib.dll
Rakitan:
netstandard.dll

Menyediakan fungsionalitas untuk memformat nilai objek menjadi representasi string.

public interface IFormattable
[System.Runtime.InteropServices.ComVisible(true)]
public interface IFormattable
Turunan
Atribut
ComVisibleAttribute

Contoh

Contoh berikut mendefinisikan Temperature kelas yang mengimplementasikan IFormattable antarmuka. Kelas ini mendukung empat penentu format: "G" dan "C", yang menunjukkan bahwa suhu akan ditampilkan di Celcius; "F", yang menunjukkan bahwa suhu akan ditampilkan di Fahrenheit; dan "K", yang menunjukkan bahwa suhu akan ditampilkan di Kelvin. Selain itu, IFormattable.ToString implementasi juga dapat menangani string format yang null atau kosong. Dua ToString metode lain yang ditentukan oleh Temperature kelas hanya membungkus panggilan ke IFormattable.ToString implementasi.

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));
      }
   }
}

Contoh berikut kemudian memanggil IFormattable.ToString implementasi baik secara langsung atau dengan menggunakan string format komposit.

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)

Keterangan

Antarmuka IFormattable mengonversi objek ke representasi stringnya berdasarkan string format dan penyedia format.

String format biasanya mendefinisikan tampilan umum objek. Misalnya, .NET Framework mendukung hal berikut:

Anda juga dapat menentukan string format Anda sendiri untuk mendukung pemformatan jenis yang ditentukan aplikasi Anda.

Penyedia format mengembalikan objek pemformatan yang biasanya menentukan simbol yang digunakan dalam mengonversi objek ke representasi stringnya. Misalnya, saat Anda mengonversi angka menjadi nilai mata uang, penyedia format menentukan simbol mata uang yang muncul dalam string hasil. .NET Framework menentukan tiga penyedia format:

Selain itu, Anda dapat menentukan penyedia format kustom Anda sendiri untuk menyediakan informasi khusus budaya, khusus profesi, atau khusus industri yang digunakan dalam pemformatan. Untuk informasi selengkapnya tentang menerapkan pemformatan kustom dengan menggunakan penyedia format kustom, lihat ICustomFormatter.

Antarmuka IFormattable mendefinisikan satu metode, ToString, yang memasok layanan pemformatan untuk jenis penerapan. Metode ini ToString dapat dipanggil secara langsung. Selain itu, ini dipanggil secara otomatis oleh Convert.ToString(Object) metode dan Convert.ToString(Object, IFormatProvider) , dan dengan metode yang menggunakan fitur pemformatan komposit di .NET Framework. Metode tersebut meliputi Console.WriteLine(String, Object), String.Format, dan StringBuilder.AppendFormat(String, Object), antara lain. Metode ToString ini dipanggil untuk setiap item format dalam string format metode.

Antarmuka IFormattable diimplementasikan oleh jenis data dasar.

Catatan Bagi Implementer

Kelas yang memerlukan kontrol lebih atas pemformatan string daripada ToString() yang disediakan harus menerapkan IFormattable.

Kelas yang menerapkan IFormattable harus mendukung penentu format "G" (umum). Selain penentu "G", kelas dapat menentukan daftar penentu format yang didukungnya. Selain itu, kelas harus disiapkan untuk menangani penentu format yaitu null. Untuk informasi selengkapnya tentang pemformatan dan kode pemformatan, lihat Tipe Pemformatan

Metode

ToString(String, IFormatProvider)

Memformat nilai instans saat ini menggunakan format yang ditentukan.

Berlaku untuk

Produk Versi
netcore-1.1 netcore-1.1

Lihat juga