IFormattable.ToString(String, IFormatProvider) Metode
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Memformat nilai instans saat ini menggunakan format yang ditentukan.
public:
System::String ^ ToString(System::String ^ format, IFormatProvider ^ formatProvider);public string ToString(string format, IFormatProvider formatProvider);public string ToString(string? format, IFormatProvider? formatProvider);abstract member ToString : string * IFormatProvider -> stringPublic Function ToString (format As String, formatProvider As IFormatProvider) As StringParameter
- format
- String
Format yang akan digunakan.
-atau-
Referensi null (Nothing di Visual Basic) untuk menggunakan format default yang ditentukan untuk jenis implementasi IFormattable.
- formatProvider
- IFormatProvider
Penyedia yang digunakan untuk memformat nilai.
-atau-
Referensi null (Nothing dalam Visual Basic) untuk mendapatkan informasi format numerik dari pengaturan lokal sistem operasi saat ini.
Mengembalikan
Nilai instans saat ini dalam format yang ditentukan.
Contoh
Contoh berikut menunjukkan Temperature kelas yang mengimplementasikan ToString metode . Contoh kode ini adalah bagian dari contoh yang lebih besar yang disediakan untuk IFormattable kelas .
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));
}
}
}
open System
open System.Globalization
type Temperature(temperature: decimal) =
do
if temperature < -273.15M then
raise (ArgumentOutOfRangeException $"{temperature} is less than absolute zero.")
member _.Celsius =
temperature
member _.Fahrenheit =
temperature * 9M / 5M + 32M
member _.Kelvin =
temperature + 273.15m
override this.ToString() =
this.ToString("G", CultureInfo.CurrentCulture)
member this.ToString(format) =
this.ToString(format, CultureInfo.CurrentCulture)
member this.ToString(format, provider: IFormatProvider) =
let format =
if String.IsNullOrEmpty format then "G"
else format
let provider =
if isNull provider then
CultureInfo.CurrentCulture :> IFormatProvider
else provider
match format.ToUpperInvariant() with
| "G" | "C" ->
temperature.ToString("F2", provider) + " °C"
| "F" ->
this.Fahrenheit.ToString("F2", provider) + " °F"
| "K" ->
this.Kelvin.ToString("F2", provider) + " K"
| _ ->
raise (FormatException $"The {format} format string is not supported.")
interface IFormattable with
member this.ToString(format, provider) = this.ToString(format, provider)
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
Keterangan
Metode ini ToString mengonversi nilai menjadi representasi string yang dapat diekspresikan dengan berbagai cara. Format yang tepat tergantung pada simbol tertentu atau urutan tertentu yang ditentukan oleh budaya, profesi, atau industri tertentu. Anda dapat memanggil metode secara langsung. Ini juga dipanggil secara otomatis oleh metode Convert.ToString(Object) dan Convert.ToString(Object, IFormatProvider), dan dengan metode yang menggunakan fitur pemformatan komposit di .NET Framework, seperti String.Format(String, Object[]), Console.WriteLine(String, Object[]), dan StringBuilder.AppendFormat(String, Object[]). (Untuk informasi selengkapnya, lihat Pemformatan Komposit.)
Metode pemformatan komposit memanggil ToString metode sekali untuk setiap item format dalam string format. Parameter yang diteruskan ke metode bergantung pada metode pemformatan tertentu yang dipanggil dan pada konten item format, sebagai berikut:
Jika item format tidak menyertakan string format (misalnya, jika item format sederhana
{0}), item tersebut diteruskannullsebagai nilai System.String parameter.Jika item format menyertakan string format (misalnya,
{0:G}), string format tersebut diteruskan sebagai nilai System.String parameter.Jika panggilan metode asli tidak menyertakan System.IFormatProvider parameter, CultureInfo.CurrentCulture diteruskan sebagai nilai System.IFormatProvider parameter.
Jika panggilan metode asli menyertakan System.IFormatProvider parameter, penyedia yang disediakan dalam panggilan metode diteruskan sebagai nilai System.IFormatProvider parameter.
Note
Implementasi objek ToString dipanggil dengan metode pemformatan komposit hanya jika mereka tidak lulus ICustomFormatter penyedia format, atau jika Format metode penyedia format kustom mengembalikan null.
.NET Framework mencakup tiga penyedia format, yang semuanya mengimplementasikan antarmuka IFormatProvider:
NumberFormatInfo menyediakan informasi pemformatan numerik, seperti karakter yang akan digunakan untuk pemisah desimal dan grup, serta ejaan dan penempatan simbol mata uang dalam nilai moneter.
DateTimeFormatInfo menyediakan informasi pemformatan terkait tanggal dan waktu, seperti posisi bulan, hari, dan tahun dalam pola tanggal.
CultureInfo berisi informasi pemformatan default dalam budaya tertentu, termasuk informasi format numerik, dan informasi pemformatan terkait tanggal dan waktu.
Selain itu, Anda dapat menentukan penyedia format kustom Anda sendiri.
Catatan Bagi Implementer
Metode ToString(String, IFormatProvider) 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.
