IFormattable Interface
Definitie
Belangrijk
Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.
Biedt functionaliteit voor het opmaken van de waarde van een object in een tekenreeksweergave.
public interface class IFormattablepublic interface IFormattable[System.Runtime.InteropServices.ComVisible(true)]
public interface IFormattabletype IFormattable = interface[<System.Runtime.InteropServices.ComVisible(true)>]
type IFormattable = interfacePublic Interface IFormattable- Afgeleid
- Kenmerken
Voorbeelden
In het volgende voorbeeld wordt een Temperature klasse gedefinieerd waarmee de IFormattable interface wordt geïmplementeerd. De klasse ondersteunt vier indelingsaanduidingen: "G" en "C", die aangeven dat de temperatuur in Celsius moet worden weergegeven; "F", die aangeeft dat de temperatuur moet worden weergegeven in Fahrenheit; en "K", wat aangeeft dat de temperatuur in Kelvin moet worden weergegeven. Daarnaast kan de IFormattable.ToString implementatie ook een notatietekenreeks verwerken die leeg is of leeg is null . De andere twee ToString methoden die door de Temperature klasse zijn gedefinieerd, verpakken gewoon een aanroep naar de IFormattable.ToString implementatie.
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
In het volgende voorbeeld wordt de IFormattable.ToString implementatie rechtstreeks of met behulp van een samengestelde notatietekenreeks aanroepen.
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)
open System
open System.Globalization
[<EntryPoint>]
let main _ =
// Use composite formatting with format string in the format item.
let temp1 = Temperature 0
Console.WriteLine("{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)\n", temp1)
// Use composite formatting with a format provider.
let temp1 = Temperature -40
String.Format(CultureInfo.CurrentCulture, "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)", temp1)
|> printfn "%s"
String.Format(CultureInfo "fr-FR", "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)\n", temp1)
|> printfn "%s"
// Call ToString method with format string.
let temp1 = 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
let temp1 = Temperature 100
let current = NumberFormatInfo.CurrentInfo
let nl = 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))
0
// 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)
Opmerkingen
De IFormattable interface converteert een object naar de tekenreeksweergave op basis van een notatietekenreeks en een indelingsprovider.
Een notatietekenreeks definieert doorgaans het algemene uiterlijk van een object. Het .NET Framework ondersteunt bijvoorbeeld het volgende:
Tekenreeksen met standaardindeling voor het opmaken van opsommingswaarden (zie Opsomming opmaaktekenreeksen).
Standaardtekenreeksen en aangepaste notatietekenreeksen voor het opmaken van numerieke waarden (zie Tekenreeksen met standaard numerieke notatie en tekenreeksen voor aangepaste numerieke notatie).
Standaard- en aangepaste notatietekenreeksen voor het opmaken van datum- en tijdwaarden (zie Standaardtekenreeksen voor datum- en tijdnotatie enaangepaste datum- en tijdnotatietekenreeksen).
Standaard- en aangepaste notatietekenreeksen voor het opmaken van tijdsintervallen (zie Tekenreeksen met standaardtijdspanne en aangepaste tijdspannotatietekenreeksen).
U kunt ook uw eigen notatietekenreeksen definiëren ter ondersteuning van de opmaak van door uw toepassing gedefinieerde typen.
Een indelingsprovider retourneert een opmaakobject dat doorgaans de symbolen definieert die worden gebruikt bij het converteren van een object naar de tekenreeksweergave. Wanneer u bijvoorbeeld een getal converteert naar een valutawaarde, definieert een notatieprovider het valutasymbool dat wordt weergegeven in de resultaattekenreeks. Het .NET Framework definieert drie indelingsproviders:
De System.Globalization.CultureInfo klasse, die een NumberFormatInfo object retourneert voor het opmaken van numerieke waarden of een DateTimeFormatInfo object voor het opmaken van datum- en tijdwaarden.
De System.Globalization.NumberFormatInfo klasse, die een exemplaar van zichzelf retourneert voor het opmaken van numerieke waarden.
De System.Globalization.DateTimeFormatInfo klasse, die een exemplaar van zichzelf retourneert voor het opmaken van datum- en tijdwaarden.
Daarnaast kunt u uw eigen aangepaste notatieproviders definiëren om cultuurspecifieke, beroepsspecifieke of branchespecifieke informatie te leveren die wordt gebruikt in opmaak. Zie voor meer informatie over het implementeren van aangepaste opmaak met behulp van een provider ICustomFormattervoor aangepaste indeling.
De IFormattable interface definieert één methode, ToStringdie opmaakservices levert voor het implementatietype. De ToString methode kan rechtstreeks worden aangeroepen. Daarnaast wordt deze automatisch aangeroepen door de methoden Convert.ToString(Object) en Convert.ToString(Object, IFormatProvider), en door methoden die gebruikmaken van de composite-opmaakfunctie in het .NET Framework. Dergelijke methoden omvatten Console.WriteLine(String, Object), String.Formaten StringBuilder.AppendFormat(String, Object), onder andere. De ToString methode wordt aangeroepen voor elk opmaakitem in de notatietekenreeks van de methode.
De IFormattable interface wordt geïmplementeerd door de basisgegevenstypen.
Notities voor uitvoerders
Klassen waarvoor meer controle nodig is over de opmaak van tekenreeksen dan ToString() biedt, moeten worden geïmplementeerd IFormattable.
Een klasse die wordt geïmplementeerd IFormattable , moet ondersteuning bieden voor de indeling 'G' (algemeen). Naast de 'G'-aanduiding kan de klasse de lijst met indelingsaanduidingen definiëren die door de klasse worden ondersteund. Bovendien moet de klasse worden voorbereid om een indelingsaanduiding te verwerken.null Zie Opmaaktypen voor meer informatie over opmaak- en opmaakcodes
Methoden
| Name | Description |
|---|---|
| ToString(String, IFormatProvider) |
Hiermee wordt de waarde van het huidige exemplaar opgemaakt met behulp van de opgegeven indeling. |
