Kommentar
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
Anmärkning
Den här artikeln innehåller ytterligare kommentarer till referensdokumentationen för det här API:et.
Viktigt!
I stället för att anropa metoden String.Format eller använda sammansatta formatsträngar kan du använda interpolerade strängar om språket stöder dem. En interpolerad sträng är en sträng som innehåller interpolerade uttryck. Varje interpolerat uttryck matchas med uttryckets värde och ingår i resultatsträngen när strängen tilldelas. Mer information finns i Stränginterpolation (C#-referens) och Interpolerade strängar (Visual Basic Reference).
Exempel
Flera exempel som anropar Format-metoden finns spridda i den här artikeln. Du kan också ladda ned en fullständig uppsättning String.Format exempel som ingår i ett .NET Core-projekt för C#.
Följande är några av exemplen som ingår i artikeln:
Skapa en formatsträng
Infoga en sträng
Formatobjektet
Formatera objekt som har samma index
Kontrollera formaterade utdata
Kontrollera formatering
Kontrollavstånd
Kontrolljustering
Kontrollera antalet heltalssiffror
Kontrollera antalet siffror efter decimalavgränsaren
Inkludera literalparenteser i resultatsträngen
Gör formatsträngar kulturkänsliga
Gör formatsträngar känsliga för kulturella skillnader
Anpassa formateringsåtgärden
En anpassad formateringsåtgärd
En avskärmningstjänst och romersk sifferformaterare
Kom igång med metoden String.Format
Använd String.Format om du behöver infoga värdet för ett objekt, en variabel eller ett uttryck i en annan sträng. Du kan till exempel infoga värdet för ett Decimal värde i en sträng för att visa det för användaren som en enda sträng:
Decimal pricePerOunce = 17.36m;
String s = String.Format("The current price is {0} per ounce.",
pricePerOunce);
Console.WriteLine(s);
// Result: The current price is 17.36 per ounce.
let pricePerOunce = 17.36m
String.Format("The current price is {0} per ounce.", pricePerOunce)
|> printfn "%s"
// Result: The current price is 17.36 per ounce.
Dim pricePerOunce As Decimal = 17.36D
Dim s As String = String.Format("The current price is {0} per ounce.",
pricePerOunce)
' Result: The current price is 17.36 per ounce.
Och du kan styra värdets formatering:
Decimal pricePerOunce = 17.36m;
String s = String.Format("The current price is {0:C2} per ounce.",
pricePerOunce);
Console.WriteLine(s);
// Result if current culture is en-US:
// The current price is $17.36 per ounce.
let pricePerOunce = 17.36m
String.Format("The current price is {0:C2} per ounce.", pricePerOunce)
|> printfn "%s"
// Result if current culture is en-US:
// The current price is $17.36 per ounce.
Dim pricePerOunce As Decimal = 17.36D
Dim s As String = String.Format("The current price is {0:C2} per ounce.",
pricePerOunce)
' Result if current culture is en-US:
' The current price is $17.36 per ounce.
Förutom formatering kan du även styra justering och avstånd.
Infoga en sträng
String.Format börjar med en formatsträng följt av ett eller flera objekt eller uttryck som ska konverteras till strängar och infogas på en angiven plats i formatsträngen. Till exempel:
decimal temp = 20.4m;
string s = String.Format("The temperature is {0}°C.", temp);
Console.WriteLine(s);
// Displays 'The temperature is 20.4°C.'
let temp = 20.4m
String.Format("The temperature is {0}°C.", temp)
|> printfn "%s"
// Displays 'The temperature is 20.4°C.'
Dim temp As Decimal = 20.4D
Dim s As String = String.Format("The temperature is {0}°C.", temp)
Console.WriteLine(s)
' Displays 'The temperature is 20.4°C.'
I formatsträngen är {0} ett formatobjekt.
0 är indexet för det objekt vars strängvärde ska infogas vid den positionen. (Index börjar vid 0.) Om objektet som ska infogas inte är en sträng anropas dess ToString metod för att konvertera det till ett innan det infogas i resultatsträngen.
Här är ett annat exempel som använder två formatobjekt och två objekt i objektlistan:
string s = String.Format("At {0}, the temperature is {1}°C.",
DateTime.Now, 20.4);
Console.WriteLine(s);
// Output similar to: 'At 4/10/2015 9:29:41 AM, the temperature is 20.4°C.'
String.Format("At {0}, the temperature is {1}°C.", DateTime.Now, 20.4)
|> printfn "%s"
// Output similar to: 'At 4/10/2015 9:29:41 AM, the temperature is 20.4°C.'
Dim s As String = String.Format("At {0}, the temperature is {1}°C.",
Date.Now, 20.4)
' Output similar to: 'At 4/10/2015 9:29:41 AM, the temperature is 20.4°C.'
Du kan ha så många formatobjekt och så många objekt i objektlistan som du vill, så länge indexet för varje formatobjekt har ett matchande objekt i objektlistan. Du behöver heller inte bekymra dig om vilken överlagring du anropar, eftersom kompilatorn kommer att välja lämplig för dig.
Kontrollera formateringen
Du kan följa indexet i ett formatobjekt med en formatsträng för att styra hur ett objekt formateras. Till exempel {0:d} tillämpar formatsträngen "d" på det första objektet i objektlistan. Här är ett exempel med ett enskilt objekt och två formatobjekt:
string s = String.Format("It is now {0:d} at {0:t}", DateTime.Now);
Console.WriteLine(s);
// Output similar to: 'It is now 4/10/2015 at 10:04 AM'
String.Format("It is now {0:d} at {0:t}", DateTime.Now)
|> printfn "%s"
// Output similar to: 'It is now 4/10/2015 at 10:04 AM'
Dim s As String = String.Format("It is now {0:d} at {0:t}",
Date.Now)
' Output similar to: 'It is now 4/10/2015 at 10:04 AM'
Många typer stöder formatsträngar, inklusive alla numeriska typer (både standardsträngar och anpassade formatsträngar), alla datum och tider (både standardsträngar och anpassade formatsträngar) och tidsintervall (både standardsträngar och anpassade formatsträngar), alla uppräkningstyper ochGUID:er. Du kan också lägga till stöd för formatsträngar i dina egna typer.
Kontrollavstånd
Du kan definiera bredden på strängen som infogas i resultatsträngen med hjälp av syntax som {0,12}, som infogar en sträng med 12 tecken. I det här fallet är strängrepresentationen av det första objektet högerjusterad i fältet med 12 tecken. (Om strängrepresentationen av det första objektet är mer än 12 tecken långt ignoreras dock den önskade fältbredden och hela strängen infogas i resultatsträngen.)
I följande exempel definieras ett fält med 6 tecken som innehåller strängen "Year" och vissa årssträngar, samt ett fält med 15 tecken som innehåller strängen "Population" och vissa populationsdata. Observera att tecknen är högerjusterade i fältet.
int[] years = { 2013, 2014, 2015 };
int[] population = { 1025632, 1105967, 1148203 };
var sb = new System.Text.StringBuilder();
sb.Append(String.Format("{0,6} {1,15}\n\n", "Year", "Population"));
for (int index = 0; index < years.Length; index++)
sb.Append(String.Format("{0,6} {1,15:N0}\n", years[index], population[index]));
Console.WriteLine(sb);
// Result:
// Year Population
//
// 2013 1,025,632
// 2014 1,105,967
// 2015 1,148,203
open System
open System.Text
let years = [| 2013; 2014; 2015 |]
let population = [| 1025632; 1105967; 1148203 |]
let sb = StringBuilder()
sb.Append(String.Format("{0,6} {1,15}\n\n", "Year", "Population")) |> ignore
for i = 0 to years.Length - 1 do
sb.Append(String.Format("{0,6} {1,15:N0}\n", years[i], population[i])) |> ignore
printfn $"{sb}"
// Result:
// Year Population
//
// 2013 1,025,632
// 2014 1,105,967
// 2015 1,148,203
Dim years() As Integer = {2013, 2014, 2015}
Dim population() As Integer = {1025632, 1105967, 1148203}
Dim sb As New StringBuilder()
sb.Append(String.Format("{0,6} {1,15}{2}{2}",
"Year", "Population", vbCrLf))
For index As Integer = 0 To years.Length - 1
sb.AppendFormat("{0,6} {1,15:N0}{2}",
years(index), population(index), vbCrLf)
Next
' Result:
' Year Population
'
' 2013 1,025,632
' 2014 1,105,967
' 2015 1,148,203
Kontrolljustering
Som standardinställning är strängar högerjusterade i sitt fält om du anger en fältbredd. Om du vill vänsterjustera strängar i ett fält anger du fältbredden med ett negativt tecken, till exempel {0,-12} för att definiera ett vänsterjusterat fält med 12 tecken.
Följande exempel liknar det föregående, förutom att det vänsterjusterar både etiketter och data.
int[] years = { 2013, 2014, 2015 };
int[] population = { 1025632, 1105967, 1148203 };
String s = String.Format("{0,-10} {1,-10}\n\n", "Year", "Population");
for (int index = 0; index < years.Length; index++)
s += String.Format("{0,-10} {1,-10:N0}\n",
years[index], population[index]);
Console.WriteLine($"\n{s}");
// Result:
// Year Population
//
// 2013 1,025,632
// 2014 1,105,967
// 2015 1,148,203
let years = [| 2013; 2014; 2015 |]
let population = [| 1025632; 1105967; 1148203 |]
let mutable s = String.Format("{0,-10} {1,-10}\n\n", "Year", "Population")
for i = 0 to years.Length - 1 do
s <- s + String.Format("{0,-10} {1,-10:N0}\n", years[i], population[i])
printfn $"\n{s}"
// Result:
// Year Population
//
// 2013 1,025,632
// 2014 1,105,967
// 2015 1,148,203
Dim years() As Integer = {2013, 2014, 2015}
Dim population() As Integer = {1025632, 1105967, 1148203}
Dim s As String = String.Format("{0,-10} {1,-10}{2}{2}",
"Year", "Population", vbCrLf)
For index As Integer = 0 To years.Length - 1
s += String.Format("{0,-10} {1,-10:N0}{2}",
years(index), population(index), vbCrLf)
Next
' Result:
' Year Population
'
' 2013 1,025,632
' 2014 1,105,967
' 2015 1,148,203
String.Format använder den sammansatta formateringsfunktionen. Mer information finns i Sammansatt formatering.
Vilken metod anropar jag?
| Mål | Anropsmetod |
|---|---|
| Formatera ett eller flera objekt med hjälp av den aktuella kulturens konventioner. | Förutom de överlagringar som innehåller en provider parameter innehåller de återstående Format överlagringarna en String parameter följt av en eller flera objektparametrar. På grund av detta behöver du inte avgöra vilken Format överlagring du avser att anropa. Språkkompilatorn väljer lämplig överlagring bland de överlagringar som inte har någon provider parameter, baserat på argumentlistan. Om din argumentlista till exempel har fem argument anropar Format(String, Object[]) kompilatorn metoden. |
| Formatera ett eller flera objekt med hjälp av konventionerna i en specifik kultur. | Varje Format överlagring som börjar med en provider parameter följs av en String parameter och en eller flera objektparametrar. På grund av detta behöver du inte avgöra vilken specifik Format överlagring du tänker anropa. Språkkompilatorn väljer lämplig överbelastning bland de överlagringar som har en provider parameter baserat på din argumentlista. Om din argumentlista till exempel har fem argument anropar Format(IFormatProvider, String, Object[]) kompilatorn metoden. |
| Utför en anpassad formateringsåtgärd antingen med en ICustomFormatter implementering eller en IFormattable implementering. | Någon av de fyra överlagringarna som har en provider-parameter. Kompilatorn väljer lämplig överlagring bland de överlagringar som har en provider parameter baserat på din argumentlista. |
Format-metoden i korthet
Varje överlagring av Format-metoden använder sammansatt formateringsfunktion för att inkludera nollbaserade platshållare, kallade formatobjekt, i en sammansatt formatsträng. Vid körning ersätts varje formatobjekt med strängrepresentationen av motsvarande argument i en parameterlista. Om värdet för argumentet är nullersätts formatobjektet med String.Empty. Följande anrop till metoden innehåller till Format(String, Object, Object, Object) exempel en formatsträng med tre formatobjekt, {0}, {1}och {2}och en argumentlista med tre objekt.
DateTime dat = new DateTime(2012, 1, 17, 9, 30, 0);
string city = "Chicago";
int temp = -16;
string output = String.Format("At {0} in {1}, the temperature was {2} degrees.",
dat, city, temp);
Console.WriteLine(output);
// The example displays output like the following:
// At 1/17/2012 9:30:00 AM in Chicago, the temperature was -16 degrees.
open System
let dat = DateTime(2012, 1, 17, 9, 30, 0)
let city = "Chicago"
let temp = -16
String.Format("At {0} in {1}, the temperature was {2} degrees.", dat, city, temp)
|> printfn "%s"
// The example displays output like the following:
// At 1/17/2012 9:30:00 AM in Chicago, the temperature was -16 degrees.
Dim dat As Date = #1/17/2012 9:30AM#
Dim city As String = "Chicago"
Dim temp As Integer = -16
Dim output As String = String.Format("At {0} in {1}, the temperature was {2} degrees.",
dat, city, temp)
Console.WriteLine(output)
' The example displays the following output:
' At 1/17/2012 9:30:00 AM in Chicago, the temperature was -16 degrees.
Formatobjektet
Ett formatobjekt har den här syntaxen:
{index[,width][:formatString]}
Klamrar anger valfria element. De inledande och avslutande klammerna krävs. (Om du vill inkludera en inledande eller avslutande klammerparentes bokstavligen i formatsträngen kan du läsa avsnittet Escaping Braces i artikeln Sammansatt formatering.)
Ett formatobjekt för att formatera ett valutavärde kan till exempel se ut så här:
var value = String.Format("{0,-10:C}", 126347.89m);
Console.WriteLine(value);
open System
String.Format("{0,-10:C}", 126347.89m)
|> printfn "%s"
String.Format("{0,-10:C}", 126347.89D)
Ett formatobjekt har följande element:
index
Det nollbaserade indexet för argumentet vars strängrepresentation ska inkluderas på den här positionen i strängen. Om det här argumentet är nullinkluderas en tom sträng på den här positionen i strängen.
width
Valfritt. Ett signerat heltal som anger den totala längden på det fält som argumentet infogas i och om det är högerjusterat (ett positivt heltal) eller vänsterjusterat (ett negativt heltal). Om du utelämnar widthinfogas strängrepresentationen av motsvarande argument i ett fält utan inledande eller avslutande blanksteg.
Om värdet width för är mindre än längden på argumentet som ska infogas width ignoreras och längden på strängrepresentationen av argumentet används som fältbredd.
formatString
Valfritt. En sträng som anger formatet på motsvarande argument resultatsträng. Om du utelämnar formatStringanropas motsvarande arguments parameterlösa ToString metod för att skapa dess strängrepresentation. Om du anger formatStringmåste argumentet som refereras av formatobjektet implementera IFormattable gränssnittet. Typer som stöder formatsträngar är:
Alla integral- och flyttalstyper. (Se Standard numeriska formatsträngar och Anpassade numeriska formatsträngar.)
DateTime och DateTimeOffset. (Se Formatsträngar för standarddatum och tid och anpassade datum- och tidsformatsträngar.)
Alla uppräkningstyper. (Se Uppräkningsformatsträngar.)
TimeSpan värden. (Se Standard TimeSpan-formatsträngar och Anpassade TimeSpan-formatsträngar.)
Guid. (Se Guid.ToString(String) metoden.)
Alla anpassade typer kan dock implementera IFormattable eller utöka implementeringen av en befintlig typ IFormattable .
I följande exempel används argumenten width och formatString för att skapa formaterade utdata.
// Create array of 5-tuples with population data for three U.S. cities, 1940-1950.
Tuple<string, DateTime, int, DateTime, int>[] cities =
{ Tuple.Create("Los Angeles", new DateTime(1940, 1, 1), 1504277,
new DateTime(1950, 1, 1), 1970358),
Tuple.Create("New York", new DateTime(1940, 1, 1), 7454995,
new DateTime(1950, 1, 1), 7891957),
Tuple.Create("Chicago", new DateTime(1940, 1, 1), 3396808,
new DateTime(1950, 1, 1), 3620962),
Tuple.Create("Detroit", new DateTime(1940, 1, 1), 1623452,
new DateTime(1950, 1, 1), 1849568) };
// Display header
var header = String.Format("{0,-12}{1,8}{2,12}{1,8}{2,12}{3,14}\n",
"City", "Year", "Population", "Change (%)");
Console.WriteLine(header);
foreach (var city in cities) {
var output = String.Format("{0,-12}{1,8:yyyy}{2,12:N0}{3,8:yyyy}{4,12:N0}{5,14:P1}",
city.Item1, city.Item2, city.Item3, city.Item4, city.Item5,
(city.Item5 - city.Item3)/ (double)city.Item3);
Console.WriteLine(output);
}
// The example displays the following output:
// City Year Population Year Population Change (%)
//
// Los Angeles 1940 1,504,277 1950 1,970,358 31.0 %
// New York 1940 7,454,995 1950 7,891,957 5.9 %
// Chicago 1940 3,396,808 1950 3,620,962 6.6 %
// Detroit 1940 1,623,452 1950 1,849,568 13.9 %
// Create a list of 5-tuples with population data for three U.S. cities, 1940-1950.
let cities =
[ "Los Angeles", DateTime(1940, 1, 1), 1504277, DateTime(1950, 1, 1), 1970358
"New York", DateTime(1940, 1, 1), 7454995, DateTime(1950, 1, 1), 7891957
"Chicago", DateTime(1940, 1, 1), 3396808, DateTime(1950, 1, 1), 3620962
"Detroit", DateTime(1940, 1, 1), 1623452, DateTime(1950, 1, 1), 1849568 ]
// Display header
String.Format("{0,-12}{1,8}{2,12}{1,8}{2,12}{3,14}\n", "City", "Year", "Population", "Change (%)")
|> printfn "%s"
for name, year1, pop1, year2, pop2 in cities do
String.Format("{0,-12}{1,8:yyyy}{2,12:N0}{3,8:yyyy}{4,12:N0}{5,14:P1}",
name, year1, pop1, year2, pop2,
double (pop2 - pop1) / double pop1)
|> printfn "%s"
// The example displays the following output:
// City Year Population Year Population Change (%)
//
// Los Angeles 1940 1,504,277 1950 1,970,358 31.0 %
// New York 1940 7,454,995 1950 7,891,957 5.9 %
// Chicago 1940 3,396,808 1950 3,620,962 6.6 %
// Detroit 1940 1,623,452 1950 1,849,568 13.9 %
Module Example3
Public Sub Main()
' Create array of 5-tuples with population data for three U.S. cities, 1940-1950.
Dim cities() =
{Tuple.Create("Los Angeles", #1/1/1940#, 1504277, #1/1/1950#, 1970358),
Tuple.Create("New York", #1/1/1940#, 7454995, #1/1/1950#, 7891957),
Tuple.Create("Chicago", #1/1/1940#, 3396808, #1/1/1950#, 3620962),
Tuple.Create("Detroit", #1/1/1940#, 1623452, #1/1/1950#, 1849568)}
' Display header
Dim header As String = String.Format("{0,-12}{1,8}{2,12}{1,8}{2,12}{3,14}",
"City", "Year", "Population", "Change (%)")
Console.WriteLine(header)
Console.WriteLine()
For Each city In cities
Dim output = String.Format("{0,-12}{1,8:yyyy}{2,12:N0}{3,8:yyyy}{4,12:N0}{5,14:P1}",
city.Item1, city.Item2, city.Item3, city.Item4, city.Item5,
(city.Item5 - city.Item3) / city.Item3)
Console.WriteLine(output)
Next
End Sub
End Module
' The example displays the following output:
' City Year Population Year Population Change (%)
'
' Los Angeles 1940 1,504,277 1950 1,970,358 31.0 %
' New York 1940 7,454,995 1950 7,891,957 5.9 %
' Chicago 1940 3,396,808 1950 3,620,962 6.6 %
' Detroit 1940 1,623,452 1950 1,849,568 13.9 %
Hur formateras argument
Formatobjekt bearbetas sekventiellt från början av strängen. Varje formatobjekt har ett index som motsvarar ett objekt i metodens argumentlista. Metoden Format hämtar argumentet och härleder dess strängrepresentation på följande sätt:
Om argumentet är
nullinfogar metoden String.Empty i resultatsträngen. Du behöver inte bry dig om att hantera ett NullReferenceException för null-argument.Om du anropar överlagringen Format(IFormatProvider, String, Object[]) och
provider-objektets IFormatProvider.GetFormat-implementering returnerar en icke-null-implementering ICustomFormatter skickas argumentet till dess ICustomFormatter.Format(String, Object, IFormatProvider)-metod. Om formatobjektet innehåller ettformatStringargument skickas det som det första argumentet till metoden. Om implementeringen ICustomFormatter är tillgänglig och genererar en icke-null-sträng returneras strängen som strängrepresentation av argumentet, annars körs nästa steg.Om argumentet implementerar IFormattable-gränssnittet, anropas dess IFormattable.ToString-implementering.
Argumentets parameterlösa
ToStringmetod, som antingen åsidosätter eller ärver från en basklassimplementering, anropas.
Ett exempel som fångar upp anrop till ICustomFormatter.Format-metoden och låter dig se vilken information Format-metoden skickar till en formateringsmetod för varje formatobjekt i en sammansatt formatsträng kan ses i Exempel: En intercept-provider och romersk talformaterare.
Mer information finns i Bearbetningsordning.
Formatera objekt som har samma index
Metoden Format genererar ett FormatException undantag om indexet för ett indexobjekt är större än eller lika med antalet argument i argumentlistan. Kan dock format innehålla fler formatobjekt än det finns argument, så länge flera formatobjekt har samma index. I anropet Format(String, Object) till metoden i följande exempel har argumentlistan ett enda argument, men formatsträngen innehåller två formatobjekt: den ena visar decimalvärdet för ett tal och det andra visar dess hexadecimala värde.
short[] values= { Int16.MinValue, -27, 0, 1042, Int16.MaxValue };
Console.WriteLine("{0,10} {1,10}\n", "Decimal", "Hex");
foreach (short value in values)
{
string formatString = String.Format("{0,10:G}: {0,10:X}", value);
Console.WriteLine(formatString);
}
// The example displays the following output:
// Decimal Hex
//
// -32768: 8000
// -27: FFE5
// 0: 0
// 1042: 412
// 32767: 7FFF
open System
let values= [| Int16.MinValue; -27s; 0s; 1042s; Int16.MaxValue |]
printfn "%10s %10s\n" "Decimal" "Hex"
for value in values do
String.Format("{0,10:G}: {0,10:X}", value)
|> printfn "%s"
// The example displays the following output:
// Decimal Hex
//
// -32768: 8000
// -27: FFE5
// 0: 0
// 1042: 412
// 32767: 7FFF
Module Example1
Public Sub Main()
Dim values() As Short = {Int16.MinValue, -27, 0, 1042, Int16.MaxValue}
Console.WriteLine("{0,10} {1,10}", "Decimal", "Hex")
Console.WriteLine()
For Each value As Short In values
Dim formatString As String = String.Format("{0,10:G}: {0,10:X}", value)
Console.WriteLine(formatString)
Next
End Sub
End Module
' The example displays the following output:
' Decimal Hex
'
' -32768: 8000
' -27: FFE5
' 0: 0
' 1042: 412
' 32767: 7FFF
Format och kultur
Vanligtvis konverteras objekt i argumentlistan till sina strängrepresentationer med hjälp av konventionerna i den aktuella kulturen, som returneras av CultureInfo.CurrentCulture egenskapen. Du kan styra det här beteendet genom att anropa en av överlagringarna av Format som innehåller en provider parameter. Parametern provider är en IFormatProvider implementering som tillhandahåller anpassad och kulturspecifik formateringsinformation som används för att moderera formateringsprocessen.
Gränssnittet IFormatProvider har en enda medlem, GetFormat, som ansvarar för att returnera objektet som tillhandahåller formateringsinformation. .NET har tre IFormatProvider implementeringar som ger kulturspecifik formatering:
- CultureInfo. Dess GetFormat metod returnerar ett kulturspecifikt NumberFormatInfo objekt för formatering av numeriska värden och ett kulturspecifikt DateTimeFormatInfo objekt för formatering av datum- och tidsvärden.
- DateTimeFormatInfo, som används för kulturspecifik formatering av datum- och tidsvärden. Metoden GetFormat returnerar sig själv.
- NumberFormatInfo, som används för kulturspecifik formatering av numeriska värden. Metoden GetFormat(Type) returnerar sig själv.
Anpassade formateringsåtgärder
Du kan också anropa någon av överlagringarna för metoden Format som har en provider parameter av typen IFormatProvider för att utföra anpassade formateringsåtgärder. Du kan till exempel formatera ett heltal som ett ID-nummer eller som ett telefonnummer. För att kunna utföra anpassad formatering måste argumentet provider implementera både gränssnitten IFormatProvider och ICustomFormatter .
Format När metoden skickas en ICustomFormatter implementering som provider argument anropar Format metoden dess IFormatProvider.GetFormat implementering och begär ett objekt av typen ICustomFormatter. Den anropar sedan ICustomFormatter-metoden hos det returnerade Format-objektet för att formatera varje formatdel i den sammansatta sträng som skickats till det.
Mer information om hur du tillhandahåller anpassade formateringslösningar finns i Så här definierar och använder du anpassade numeriska formatproviders och ICustomFormatter. Ett exempel som konverterar heltal till formaterade anpassade tal finns i Exempel: En anpassad formateringsåtgärd. Ett exempel som konverterar osignerade byte till romerska siffror finns i Exempel: En avlyssningsleverantör och romersk talformaterare.
Exempel: En anpassad formateringsåtgärd
Det här exemplet definierar en formatprovider som formaterar ett heltalsvärde som ett kundkontonummer i formuläret x-xxxxx-xx.
using System;
public class TestFormatter
{
public static void Main()
{
int acctNumber = 79203159;
Console.WriteLine(String.Format(new CustomerFormatter(), "{0}", acctNumber));
Console.WriteLine(String.Format(new CustomerFormatter(), "{0:G}", acctNumber));
Console.WriteLine(String.Format(new CustomerFormatter(), "{0:S}", acctNumber));
Console.WriteLine(String.Format(new CustomerFormatter(), "{0:P}", acctNumber));
try {
Console.WriteLine(String.Format(new CustomerFormatter(), "{0:X}", acctNumber));
}
catch (FormatException e) {
Console.WriteLine(e.Message);
}
}
}
public class CustomerFormatter : IFormatProvider, ICustomFormatter
{
public object GetFormat(Type formatType)
{
if (formatType == typeof(ICustomFormatter))
return this;
else
return null;
}
public string Format(string format,
object arg,
IFormatProvider formatProvider)
{
if (! this.Equals(formatProvider))
{
return null;
}
else
{
if (String.IsNullOrEmpty(format))
format = "G";
string customerString = arg.ToString();
if (customerString.Length < 8)
customerString = customerString.PadLeft(8, '0');
format = format.ToUpper();
switch (format)
{
case "G":
return customerString.Substring(0, 1) + "-" +
customerString.Substring(1, 5) + "-" +
customerString.Substring(6);
case "S":
return customerString.Substring(0, 1) + "/" +
customerString.Substring(1, 5) + "/" +
customerString.Substring(6);
case "P":
return customerString.Substring(0, 1) + "." +
customerString.Substring(1, 5) + "." +
customerString.Substring(6);
default:
throw new FormatException(
String.Format("The '{0}' format specifier is not supported.", format));
}
}
}
}
// The example displays the following output:
// 7-92031-59
// 7-92031-59
// 7/92031/59
// 7.92031.59
// The 'X' format specifier is not supported.
open System
type CustomerFormatter() =
interface IFormatProvider with
member this.GetFormat(formatType) =
if formatType = typeof<ICustomFormatter> then
this
else
null
interface ICustomFormatter with
member this.Format(format, arg, formatProvider: IFormatProvider) =
if this.Equals formatProvider |> not then
null
else
let format =
if String.IsNullOrEmpty format then "G"
else format.ToUpper()
let customerString =
let s = string arg
if s.Length < 8 then
s.PadLeft(8, '0')
else s
match format with
| "G" ->
customerString.Substring(0, 1) + "-" +
customerString.Substring(1, 5) + "-" +
customerString.Substring 6
| "S" ->
customerString.Substring(0, 1) + "/" +
customerString.Substring(1, 5) + "/" +
customerString.Substring 6
| "P" ->
customerString.Substring(0, 1) + "." +
customerString.Substring(1, 5) + "." +
customerString.Substring 6
| _ ->
raise (FormatException $"The '{format}' format specifier is not supported.")
let acctNumber = 79203159
String.Format(CustomerFormatter(), "{0}", acctNumber)
|> printfn "%s"
String.Format(CustomerFormatter(), "{0:G}", acctNumber)
|> printfn "%s"
String.Format(CustomerFormatter(), "{0:S}", acctNumber)
|> printfn "%s"
String.Format(CustomerFormatter(), "{0:P}", acctNumber)
|> printfn "%s"
try
String.Format(CustomerFormatter(), "{0:X}", acctNumber)
|> printfn "%s"
with :? FormatException as e ->
printfn $"{e.Message}"
// The example displays the following output:
// 7-92031-59
// 7-92031-59
// 7/92031/59
// 7.92031.59
// The 'X' format specifier is not supported.
Module TestFormatter
Public Sub Main()
Dim acctNumber As Integer = 79203159
Console.WriteLine(String.Format(New CustomerFormatter, "{0}", acctNumber))
Console.WriteLine(String.Format(New CustomerFormatter, "{0:G}", acctNumber))
Console.WriteLine(String.Format(New CustomerFormatter, "{0:S}", acctNumber))
Console.WriteLine(String.Format(New CustomerFormatter, "{0:P}", acctNumber))
Try
Console.WriteLine(String.Format(New CustomerFormatter, "{0:X}", acctNumber))
Catch e As FormatException
Console.WriteLine(e.Message)
End Try
End Sub
End Module
Public Class CustomerFormatter : Implements IFormatProvider, ICustomFormatter
Public Function GetFormat(type As Type) As Object _
Implements IFormatProvider.GetFormat
If type Is GetType(ICustomFormatter) Then
Return Me
Else
Return Nothing
End If
End Function
Public Function Format(fmt As String, _
arg As Object, _
formatProvider As IFormatProvider) As String _
Implements ICustomFormatter.Format
If Not Me.Equals(formatProvider) Then
Return Nothing
Else
If String.IsNullOrEmpty(fmt) Then fmt = "G"
Dim customerString As String = arg.ToString()
if customerString.Length < 8 Then _
customerString = customerString.PadLeft(8, "0"c)
Select Case fmt
Case "G"
Return customerString.Substring(0, 1) & "-" & _
customerString.Substring(1, 5) & "-" & _
customerString.Substring(6)
Case "S"
Return customerString.Substring(0, 1) & "/" & _
customerString.Substring(1, 5) & "/" & _
customerString.Substring(6)
Case "P"
Return customerString.Substring(0, 1) & "." & _
customerString.Substring(1, 5) & "." & _
customerString.Substring(6)
Case Else
Throw New FormatException( _
String.Format("The '{0}' format specifier is not supported.", fmt))
End Select
End If
End Function
End Class
' The example displays the following output:
' 7-92031-59
' 7-92031-59
' 7/92031/59
' 7.92031.59
' The 'X' format specifier is not supported.
Exempel: En avlyssningsleverantör och romersk sifferformatterare
Det här exemplet definierar en anpassad formatprovider som implementerar gränssnitten ICustomFormatter och IFormatProvider för att göra två saker:
- Den visar parametrarna som skickas till implementeringen ICustomFormatter.Format . På så sätt kan vi se vilka parametrar Format(IFormatProvider, String, Object[]) metoden skickar till den anpassade formateringsimplementeringen för varje objekt som den försöker formatera. Detta kan vara användbart när du felsöker ditt program.
- Om objektet som ska formateras är ett osignerat bytevärde som ska formateras med standardformatsträngen "R" formateras det numeriska värdet som ett romerskt tal.
using System;
using System.Globalization;
public class InterceptProvider : IFormatProvider, ICustomFormatter
{
public object GetFormat(Type formatType)
{
if (formatType == typeof(ICustomFormatter))
return this;
else
return null;
}
public string Format(String format, Object obj, IFormatProvider provider)
{
// Display information about method call.
string formatString = format ?? "<null>";
Console.WriteLine("Provider: {0}, Object: {1}, Format String: {2}",
provider.GetType().Name, obj ?? "<null>", formatString);
if (obj == null) return String.Empty;
// If this is a byte and the "R" format string, format it with Roman numerals.
if (obj is Byte && formatString.ToUpper().Equals("R")) {
Byte value = (Byte) obj;
int remainder;
int result;
String returnString = String.Empty;
// Get the hundreds digit(s)
result = Math.DivRem(value, 100, out remainder);
if (result > 0)
returnString = new String('C', result);
value = (Byte) remainder;
// Get the 50s digit
result = Math.DivRem(value, 50, out remainder);
if (result == 1)
returnString += "L";
value = (Byte) remainder;
// Get the tens digit.
result = Math.DivRem(value, 10, out remainder);
if (result > 0)
returnString += new String('X', result);
value = (Byte) remainder;
// Get the fives digit.
result = Math.DivRem(value, 5, out remainder);
if (result > 0)
returnString += "V";
value = (Byte) remainder;
// Add the ones digit.
if (remainder > 0)
returnString += new String('I', remainder);
// Check whether we have too many X characters.
int pos = returnString.IndexOf("XXXX");
if (pos >= 0) {
int xPos = returnString.IndexOf("L");
if (xPos >= 0 & xPos == pos - 1)
returnString = returnString.Replace("LXXXX", "XC");
else
returnString = returnString.Replace("XXXX", "XL");
}
// Check whether we have too many I characters
pos = returnString.IndexOf("IIII");
if (pos >= 0)
if (returnString.IndexOf("V") >= 0)
returnString = returnString.Replace("VIIII", "IX");
else
returnString = returnString.Replace("IIII", "IV");
return returnString;
}
// Use default for all other formatting.
if (obj is IFormattable)
return ((IFormattable) obj).ToString(format, CultureInfo.CurrentCulture);
else
return obj.ToString();
}
}
public class Example
{
public static void Main()
{
int n = 10;
double value = 16.935;
DateTime day = DateTime.Now;
InterceptProvider provider = new InterceptProvider();
Console.WriteLine(String.Format(provider, "{0:N0}: {1:C2} on {2:d}\n", n, value, day));
Console.WriteLine(String.Format(provider, "{0}: {1:F}\n", "Today: ",
(DayOfWeek) DateTime.Now.DayOfWeek));
Console.WriteLine(String.Format(provider, "{0:X}, {1}, {2}\n",
(Byte) 2, (Byte) 12, (Byte) 199));
Console.WriteLine(String.Format(provider, "{0:R}, {1:R}, {2:R}\n",
(Byte) 2, (Byte) 12, (Byte) 199));
}
}
// The example displays the following output:
// Provider: InterceptProvider, Object: 10, Format String: N0
// Provider: InterceptProvider, Object: 16.935, Format String: C2
// Provider: InterceptProvider, Object: 1/31/2013 6:10:28 PM, Format String: d
// 10: $16.94 on 1/31/2013
//
// Provider: InterceptProvider, Object: Today: , Format String: <null>
// Provider: InterceptProvider, Object: Thursday, Format String: F
// Today: : Thursday
//
// Provider: InterceptProvider, Object: 2, Format String: X
// Provider: InterceptProvider, Object: 12, Format String: <null>
// Provider: InterceptProvider, Object: 199, Format String: <null>
// 2, 12, 199
//
// Provider: InterceptProvider, Object: 2, Format String: R
// Provider: InterceptProvider, Object: 12, Format String: R
// Provider: InterceptProvider, Object: 199, Format String: R
// II, XII, CXCIX
open System
open System.Globalization
type InterceptProvider() =
interface IFormatProvider with
member this.GetFormat(formatType) =
if formatType = typeof<ICustomFormatter> then
this
else
null
interface ICustomFormatter with
member _.Format(format, obj, provider: IFormatProvider) =
// Display information about method call.
let formatString =
if format = null then "<null>" else format
printfn $"Provider: {provider.GetType().Name}, Object: %A{obj}, Format String: %s{formatString}"
if obj = null then
String.Empty
else
// If this is a byte and the "R" format string, format it with Roman numerals.
match obj with
| :? byte as value when formatString.ToUpper().Equals "R" ->
let mutable returnString = String.Empty
// Get the hundreds digit(s)
let struct (result, remainder) = Math.DivRem(value, 100uy)
if result > 0uy then
returnString <- String('C', int result)
let value = byte remainder
// Get the 50s digit
let struct (result, remainder) = Math.DivRem(value, 50uy)
if result = 1uy then
returnString <- returnString + "L"
let value = byte remainder
// Get the tens digit.
let struct (result, remainder) = Math.DivRem(value, 10uy)
if result > 0uy then
returnString <- returnString + String('X', int result)
let value = byte remainder
// Get the fives digit.
let struct (result, remainder) = Math.DivRem(value, 5uy)
if result > 0uy then
returnString <- returnString + "V"
let value = byte remainder
// Add the ones digit.
if remainder > 0uy then
returnString <- returnString + String('I', int remainder)
// Check whether we have too many X characters.
let pos = returnString.IndexOf "XXXX"
if pos >= 0 then
let xPos = returnString.IndexOf "L"
returnString <-
if xPos >= 0 && xPos = pos - 1 then
returnString.Replace("LXXXX", "XC")
else
returnString.Replace("XXXX", "XL")
// Check whether we have too many I characters
let pos = returnString.IndexOf "IIII"
if pos >= 0 then
returnString <-
if returnString.IndexOf "V" >= 0 then
returnString.Replace("VIIII", "IX")
else
returnString.Replace("IIII", "IV")
returnString
// Use default for all other formatting.
| :? IFormattable as x ->
x.ToString(format, CultureInfo.CurrentCulture)
| _ ->
string obj
let n = 10
let value = 16.935
let day = DateTime.Now
let provider = InterceptProvider()
String.Format(provider, "{0:N0}: {1:C2} on {2:d}\n", n, value, day)
|> printfn "%s"
String.Format(provider, "{0}: {1:F}\n", "Today: ", DateTime.Now.DayOfWeek)
|> printfn "%s"
String.Format(provider, "{0:X}, {1}, {2}\n", 2uy, 12uy, 199uy)
|> printfn "%s"
String.Format(provider, "{0:R}, {1:R}, {2:R}\n", 2uy, 12uy, 199uy)
|> printfn "%s"
// The example displays the following output:
// Provider: InterceptProvider, Object: 10, Format String: N0
// Provider: InterceptProvider, Object: 16.935, Format String: C2
// Provider: InterceptProvider, Object: 1/31/2013 6:10:28 PM, Format String: d
// 10: $16.94 on 1/31/2013
//
// Provider: InterceptProvider, Object: Today: , Format String: <null>
// Provider: InterceptProvider, Object: Thursday, Format String: F
// Today: : Thursday
//
// Provider: InterceptProvider, Object: 2, Format String: X
// Provider: InterceptProvider, Object: 12, Format String: <null>
// Provider: InterceptProvider, Object: 199, Format String: <null>
// 2, 12, 199
//
// Provider: InterceptProvider, Object: 2, Format String: R
// Provider: InterceptProvider, Object: 12, Format String: R
// Provider: InterceptProvider, Object: 199, Format String: R
// II, XII, CXCIX
Imports System.Globalization
Public Class InterceptProvider : Implements IFormatProvider, ICustomFormatter
Public Function GetFormat(formatType As Type) As Object _
Implements IFormatProvider.GetFormat
If formatType Is GetType(ICustomFormatter) Then
Return Me
Else
Return Nothing
End If
End Function
Public Function Format(fmt As String, obj As Object, provider As IFormatProvider) As String _
Implements ICustomFormatter.Format
Dim formatString As String = If(fmt IsNot Nothing, fmt, "<null>")
Console.WriteLine("Provider: {0}, Object: {1}, Format String: {2}",
provider, If(obj IsNot Nothing, obj, "<null>"), formatString)
If obj Is Nothing Then Return String.Empty
' If this is a byte and the "R" format string, format it with Roman numerals.
If TypeOf(obj) Is Byte AndAlso formatString.ToUpper.Equals("R") Then
Dim value As Byte = CByte(obj)
Dim remainder As Integer
Dim result As Integer
Dim returnString As String = String.Empty
' Get the hundreds digit(s)
result = Math.DivRem(value, 100, remainder)
If result > 0 Then returnString = New String("C"c, result)
value = CByte(remainder)
' Get the 50s digit
result = Math.DivRem(value, 50, remainder)
If result = 1 Then returnString += "L"
value = CByte(remainder)
' Get the tens digit.
result = Math.DivRem(value, 10, remainder)
If result > 0 Then returnString += New String("X"c, result)
value = CByte(remainder)
' Get the fives digit.
result = Math.DivRem(value, 5, remainder)
If result > 0 Then returnString += "V"
value = CByte(remainder)
' Add the ones digit.
If remainder > 0 Then returnString += New String("I"c, remainder)
' Check whether we have too many X characters.
Dim pos As Integer = returnString.IndexOf("XXXX")
If pos >= 0 Then
Dim xPos As Integer = returnString.IndexOf("L")
If xPos >= 0 And xPos = pos - 1 Then
returnString = returnString.Replace("LXXXX", "XC")
Else
returnString = returnString.Replace("XXXX", "XL")
End If
End If
' Check whether we have too many I characters
pos = returnString.IndexOf("IIII")
If pos >= 0 Then
If returnString.IndexOf("V") >= 0 Then
returnString = returnString.Replace("VIIII", "IX")
Else
returnString = returnString.Replace("IIII", "IV")
End If
End If
Return returnString
End If
' Use default for all other formatting.
If obj Is GetType(IFormattable)
Return CType(obj, IFormattable).ToString(fmt, CultureInfo.CurrentCulture)
Else
Return obj.ToString()
End If
End Function
End Class
Module Example
Public Sub Main()
Dim n As Integer = 10
Dim value As Double = 16.935
Dim day As DateTime = Date.Now
Dim provider As New InterceptProvider()
Console.WriteLine(String.Format(provider, "{0:N0}: {1:C2} on {2:d}", n, value, day))
Console.WriteLine()
Console.WriteLine(String.Format(provider, "{0}: {1:F}", "Today",
CType(Date.Now.DayOfWeek, DayOfWeek)))
Console.WriteLine()
Console.WriteLine(String.Format(provider, "{0:X}, {1}, {2}\n",
CByte(2), CByte(12), CByte(199)))
Console.WriteLine()
Console.WriteLine(String.Format(provider, "{0:R}, {1:R}, {2:R}",
CByte(2), CByte(12), CByte(199)))
End Sub
End Module
' The example displays the following output:
' Provider: InterceptProvider, Object: 10, Format String: N0
' Provider: InterceptProvider, Object: 16.935, Format String: C2
' Provider: InterceptProvider, Object: 1/31/2013 6:10:28 PM, Format String: d
' 10: $16.94 on 1/31/2013
'
' Provider: InterceptProvider, Object: Today: , Format String: <null>
' Provider: InterceptProvider, Object: Thursday, Format String: F
' Today: : Thursday
'
' Provider: InterceptProvider, Object: 2, Format String: X
' Provider: InterceptProvider, Object: 12, Format String: <null>
' Provider: InterceptProvider, Object: 199, Format String: <null>
' 2, 12, 199
'
' Provider: InterceptProvider, Object: 2, Format String: R
' Provider: InterceptProvider, Object: 12, Format String: R
' Provider: InterceptProvider, Object: 199, Format String: R
' II, XII, CXCIX
Vanliga frågor
Varför rekommenderar du stränginterpolering över anrop till String.Format metoden?
Stränginterpolation är:
- Mer flexibel. Den kan användas i valfri sträng utan att kräva ett anrop till en metod som stöder sammansatt formatering. Annars måste du anropa Format metoden eller en annan metod som stöder sammansatt formatering, till exempel Console.WriteLine eller StringBuilder.AppendFormat.
- Mer läsbar. Eftersom uttrycket som ska infogas i en sträng visas i det interpolerade uttrycket i stället för i en argumentlista är interpolerade strängar enklare att koda och läsa. Interpolerade strängar kan också användas i strängsammanfogningsåtgärder för att skapa mer koncis och tydligare kod.
En jämförelse av följande två kodexempel visar interpolerade strängars överlägsenhet jämfört med strängkonkatenering och anrop till sammansatta formateringsmetoder. Användningen av flera strängsammanfogningsåtgärder i följande exempel ger utförlig och svårläst kod.
string[] names = { "Balto", "Vanya", "Dakota", "Samuel", "Koani", "Yiska", "Yuma" };
string output = names[0] + ", " + names[1] + ", " + names[2] + ", " +
names[3] + ", " + names[4] + ", " + names[5] + ", " +
names[6];
output += "\n";
var date = DateTime.Now;
output += String.Format("It is {0:t} on {0:d}. The day of the week is {1}.",
date, date.DayOfWeek);
Console.WriteLine(output);
// The example displays the following output:
// Balto, Vanya, Dakota, Samuel, Koani, Yiska, Yuma
// It is 10:29 AM on 1/8/2018. The day of the week is Monday.
open System
let names = [| "Balto"; "Vanya"; "Dakota"; "Samuel"; "Koani"; "Yiska"; "Yuma" |]
let output =
names[0] + ", " + names[1] + ", " + names[2] + ", " +
names[3] + ", " + names[4] + ", " + names[5] + ", " +
names[6] + "\n"
let date = DateTime.Now
output + String.Format("It is {0:t} on {0:d}. The day of the week is {1}.", date, date.DayOfWeek)
|> printfn "%s"
// The example displays the following output:
// Balto, Vanya, Dakota, Samuel, Koani, Yiska, Yuma
// It is 10:29 AM on 1/8/2018. The day of the week is Monday.
Module Example12
Public Sub Main()
Dim names = {"Balto", "Vanya", "Dakota", "Samuel", "Koani", "Yiska", "Yuma"}
Dim output = names(0) + ", " + names(1) + ", " + names(2) + ", " +
names(3) + ", " + names(4) + ", " + names(5) + ", " +
names(6)
output += vbCrLf
Dim dat = DateTime.Now
output += String.Format("It is {0:t} on {0:d}. The day of the week is {1}.",
dat, dat.DayOfWeek)
Console.WriteLine(output)
End Sub
End Module
' The example displays the following output:
' Balto, Vanya, Dakota, Samuel, Koani, Yiska, Yuma
' It is 10:29 AM on 1/8/2018. The day of the week is Monday.
Användningen av interpolerade strängar i följande exempel ger däremot mycket tydligare, mer koncis kod än strängsammanfogningssatsen och anropet Format till metoden i föregående exempel.
string[] names = { "Balto", "Vanya", "Dakota", "Samuel", "Koani", "Yiska", "Yuma" };
string output = $"{names[0]}, {names[1]}, {names[2]}, {names[3]}, {names[4]}, " +
$"{names[5]}, {names[6]}";
var date = DateTime.Now;
output += $"\nIt is {date:t} on {date:d}. The day of the week is {date.DayOfWeek}.";
Console.WriteLine(output);
// The example displays the following output:
// Balto, Vanya, Dakota, Samuel, Koani, Yiska, Yuma
// It is 10:29 AM on 1/8/2018. The day of the week is Monday.
open System
let names = [| "Balto"; "Vanya"; "Dakota"; "Samuel"; "Koani"; "Yiska"; "Yuma" |]
let output = $"{names[0]}, {names[1]}, {names[2]}, {names[3]}, {names[4]}, {names[5]}, {names[6]}"
let date = DateTime.Now
output + $"\nIt is {date:t} on {date:d}. The day of the week is {date.DayOfWeek}."
|> printfn "%s"
// The example displays the following output:
// Balto, Vanya, Dakota, Samuel, Koani, Yiska, Yuma
// It is 10:29 AM on 1/8/2018. The day of the week is Monday.
Module Example13
Public Sub Main()
Dim names = {"Balto", "Vanya", "Dakota", "Samuel", "Koani", "Yiska", "Yuma"}
Dim output = $"{names(0)}, {names(1)}, {names(2)}, {names(3)}, {names(4)}, " +
$"{names(5)}, {names(6)}"
Dim dat = DateTime.Now
output += $"{vbCrLf}It is {dat:t} on {dat:d}. The day of the week is {dat.DayOfWeek}."
Console.WriteLine(output)
End Sub
End Module
' The example displays the following output:
' Balto, Vanya, Dakota, Samuel, Koani, Yiska, Yuma
' It is 10:29 AM on 1/8/2018. The day of the week is Monday.
Var hittar jag de fördefinierade formatsträngarna?
- Se alla heltals- och flyttalstyper i Standard numeriska formatsträngar och Anpassade numeriska formatsträngar.
- För datum- och tidsvärden, se Standard datum- och tidsformatsträngar och Anpassade datum- och tidsformatsträngar.
- Information om uppräkningsvärden finns i Uppräkningsformatsträngar.
- För TimeSpan-värden, se Standard TimeSpan Format Strings och Custom TimeSpan Format Strings.
- Värden Guid finns i avsnittet Kommentarer på Guid.ToString(String) referenssidan.
Hur styr jag justeringen av resultatsträngarna som ersätter formatobjekt?
Den allmänna syntaxen för ett formatobjekt är:
{index[,width][: formatString]}
width är ett signerat heltal som definierar fältbredden. Om det här värdet är negativt är texten i fältet vänsterjusterad. Om det är positivt är texten högerjusterad.
Hur styr jag antalet siffror efter decimaltecknet?
Alla numeriska standardformatsträngar utom "D" (som endast används med heltal), "G", "R" och "X" tillåter en precisionsspecificerare som definierar antalet decimalsiffror i resultatsträngen. I följande exempel används numeriska standardformatsträngar för att styra antalet decimaltal i resultatsträngen.
object[] values = { 1603, 1794.68235, 15436.14 };
string result;
foreach (var value in values)
{
result = String.Format("{0,12:C2} {0,12:E3} {0,12:F4} {0,12:N3} {1,12:P2}\n",
Convert.ToDouble(value), Convert.ToDouble(value) / 10000);
Console.WriteLine(result);
}
// The example displays output like the following:
// $1,603.00 1.603E+003 1603.0000 1,603.000 16.03 %
//
// $1,794.68 1.795E+003 1794.6824 1,794.682 17.95 %
//
// $15,436.14 1.544E+004 15436.1400 15,436.140 154.36 %
open System
let values: obj list = [ 1603, 1794.68235, 15436.14 ]
for value in values do
String.Format("{0,12:C2} {0,12:E3} {0,12:F4} {0,12:N3} {1,12:P2}\n", Convert.ToDouble(value), Convert.ToDouble(value) / 10000.)
|> printfn "%s"
// The example displays output like the following:
// $1,603.00 1.603E+003 1603.0000 1,603.000 16.03 %
//
// $1,794.68 1.795E+003 1794.6824 1,794.682 17.95 %
//
// $15,436.14 1.544E+004 15436.1400 15,436.140 154.36 %
Module Example7
Public Sub Main()
Dim values() As Object = {1603, 1794.68235, 15436.14}
Dim result As String
For Each value In values
result = String.Format("{0,12:C2} {0,12:E3} {0,12:F4} {0,12:N3} {1,12:P2}",
value, CDbl(value) / 10000)
Console.WriteLine(result)
Console.WriteLine()
Next
End Sub
End Module
' The example displays the following output:
' $1,603.00 1.603E+003 1603.0000 1,603.000 16.03 %
'
' $1,794.68 1.795E+003 1794.6824 1,794.682 17.95 %
'
' $15,436.14 1.544E+004 15436.1400 15,436.140 154.36 %
Om du använder en anpassad numerisk formatsträng använder du formatspecificeraren "0" för att styra antalet decimalsiffror i resultatsträngen, vilket visas i följande exempel.
decimal value = 16309.5436m;
string result = String.Format("{0,12:#.00000} {0,12:0,000.00} {0,12:000.00#}",
value);
Console.WriteLine(result);
// The example displays the following output:
// 16309.54360 16,309.54 16309.544
let value = 16309.5436m
String.Format("{0,12:#.00000} {0,12:0,000.00} {0,12:000.00#}", value)
|> printfn "%s"
// The example displays the following output:
// 16309.54360 16,309.54 16309.544
Module Example8
Public Sub Main()
Dim value As Decimal = 16309.5436D
Dim result As String = String.Format("{0,12:#.00000} {0,12:0,000.00} {0,12:000.00#}",
value)
Console.WriteLine(result)
End Sub
End Module
' The example displays the following output:
' 16309.54360 16,309.54 16309.544
Hur styr jag antalet heltalssiffror?
Som standard visar formateringsåtgärder endast icke-noll integralsiffror. Om du formaterar heltal kan du använda en precisionsspecificerare med standardformatsträngarna "D" och "X" för att styra antalet siffror.
int value = 1326;
string result = String.Format("{0,10:D6} {0,10:X8}", value);
Console.WriteLine(result);
// The example displays the following output:
// 001326 0000052E
open System
let value = 1326
String.Format("{0,10:D6} {0,10:X8}", value)
|> printfn "%s"
// The example displays the following output:
// 001326 0000052E
Module Example10
Public Sub Main()
Dim value As Integer = 1326
Dim result As String = String.Format("{0,10:D6} {0,10:X8}", value)
Console.WriteLine(result)
End Sub
End Module
' The example displays the following output:
' 001326 0000052E
Du kan fylla på ett heltal eller flyttalsnummer med inledande nollor för att skapa en resultatsträng med ett angivet antal heltalssiffror med hjälp av den anpassade numeriska formatspecificeraren "0", som i följande exempel visas.
int value = 16342;
string result = String.Format("{0,18:00000000} {0,18:00000000.000} {0,18:000,0000,000.0}",
value);
Console.WriteLine(result);
// The example displays the following output:
// 00016342 00016342.000 0,000,016,342.0
open System
let value = 16342
String.Format("{0,18:00000000} {0,18:00000000.000} {0,18:000,0000,000.0}", value)
|> printfn "%s"
// The example displays the following output:
// 00016342 00016342.000 0,000,016,342.0
Module Example9
Public Sub Main()
Dim value As Integer = 16342
Dim result As String = String.Format("{0,18:00000000} {0,18:00000000.000} {0,18:000,0000,000.0}",
value)
Console.WriteLine(result)
End Sub
End Module
' The example displays the following output:
' 00016342 00016342.000 0,000,016,342.0
Hur många objekt kan jag ta med i formatlistan?
Det finns ingen praktisk gräns. Den andra parametern för Format(IFormatProvider, String, Object[]) metoden är taggad med ParamArrayAttribute attributet, vilket gör att du kan inkludera antingen en avgränsad lista eller en objektmatris som formatlista.
Hur tar jag med literalparenteser ("{" och "}") i resultatsträngen?
Hur förhindrar du till exempel att följande metodanrop genererar ett FormatException undantag?
result = String.Format("The text has {0} '{' characters and {1} '}' characters.",
nOpen, nClose);
let result =
String.Format("The text has {0} '{' characters and {1} '}' characters.", nOpen, nClose)
result = String.Format("The text has {0} '{' characters and {1} '}' characters.",
nOpen, nClose)
En enda inledande eller avslutande klammerparentes tolkas alltid som början eller slutet av ett formatobjekt. För att tolkas bokstavligen måste det undkommas. Du slipper en klammerparentes genom att lägga till en annan klammerparentes ("{{" och "}}" i stället för {" och "}"), som i följande metodanrop:
string result;
int nOpen = 1;
int nClose = 2;
result = String.Format("The text has {0} '{{' characters and {1} '}}' characters.",
nOpen, nClose);
Console.WriteLine(result);
let result =
String.Format("The text has {0} '{{' characters and {1} '}}' characters.", nOpen, nClose)
result = String.Format("The text has {0} '{{' characters and {1} '}}' characters.",
nOpen, nClose)
Men även undantagna klammerparenteser är lätt feltolkade. Vi rekommenderar att du inkluderar klammerparenteser i formatlistan och använder formatobjekt för att infoga dem i resultatsträngen, vilket visas i följande exempel.
string result;
int nOpen = 1;
int nClose = 2;
result = String.Format("The text has {0} '{1}' characters and {2} '{3}' characters.",
nOpen, "{", nClose, "}");
Console.WriteLine(result);
let result =
String.Format("The text has {0} '{1}' characters and {2} '{3}' characters.", nOpen, "{", nClose, "}")
result = String.Format("The text has {0} '{1}' characters and {2} '{3}' characters.",
nOpen, "{", nClose, "}")
Varför genererar mitt anrop till metoden String.Format ett FormatException?
Den vanligaste orsaken till undantaget är att indexet för ett formatobjekt inte motsvarar ett objekt i formatlistan. Detta indikerar vanligtvis att du har felnumrerat indexen för formatobjekt eller att du har glömt att inkludera ett objekt i formatlistan. Försök att inkludera ett icke-escapat tecken för vänster eller höger klammerparentes utlöser också en FormatException. Ibland är undantaget resultatet av ett stavfel. Ett vanligt misstag är till exempel att skriva fel "[" (vänster hakparentes) i stället för "{" (vänster klammerparentes).
Om metoden Format(System.IFormatProvider,System.String,System.Object[]) stöder parametermatriser, varför utlöser min kod ett undantag när jag använder en matris?
Följande kod genererar till exempel ett FormatException undantag:
Random rnd = new Random();
int[] numbers = new int[4];
int total = 0;
for (int ctr = 0; ctr <= 2; ctr++)
{
int number = rnd.Next(1001);
numbers[ctr] = number;
total += number;
}
numbers[3] = total;
Console.WriteLine($"{numbers} + {1} + {2} = {3}");
open System
let rnd = Random()
let mutable total = 0
let numbers = Array.zeroCreate<int> 4
for i = 0 to 2 do
let number = rnd.Next 1001
numbers[i] <- number
total <- total + number
numbers[3] <- total
Console.WriteLine("{0} + {1} + {2} = {3}", numbers)
Imports System.Collections.Generic
Module Example5
Public Sub Main()
Dim rnd As New Random()
Dim numbers(3) As Integer
Dim total As Integer = 0
For ctr = 0 To 2
Dim number As Integer = rnd.Next(1001)
numbers(ctr) = number
total += number
Next
numbers(3) = total
Console.WriteLine("{0} + {1} + {2} = {3}", numbers)
End Sub
End Module
Det här är ett problem med kompilatorns överbelastningsmatchning. Eftersom kompilatorn inte kan konvertera en matris med heltal till en objektmatris behandlar den heltalsmatrisen som ett enda argument, så den anropar Format(String, Object) metoden. Undantaget genereras eftersom det finns fyra formatobjekt men bara ett enda objekt i formatlistan.
Eftersom varken Visual Basic eller C# kan konvertera en heltalsmatris till en objektmatris måste du utföra konverteringen själv innan du Format(String, Object[]) anropar metoden. I följande exempel finns en implementering.
Random rnd = new Random();
int[] numbers = new int[4];
int total = 0;
for (int ctr = 0; ctr <= 2; ctr++)
{
int number = rnd.Next(1001);
numbers[ctr] = number;
total += number;
}
numbers[3] = total;
object[] values = new object[numbers.Length];
numbers.CopyTo(values, 0);
Console.WriteLine($"{values} + {1} + {2} = {3}");
open System
let rnd = Random()
let numbers = Array.zeroCreate<int> 4
let mutable total = 0
for i = 0 to 2 do
let number = rnd.Next 1001
numbers[i] <- number
total <- total + number
numbers[3] <- total
let values = Array.zeroCreate<obj> numbers.Length
numbers.CopyTo(values, 0)
Console.WriteLine("{0} + {1} + {2} = {3}", values)
Imports System.Collections.Generic
Module Example6
Public Sub Main()
Dim rnd As New Random()
Dim numbers(3) As Integer
Dim total As Integer = 0
For ctr = 0 To 2
Dim number As Integer = rnd.Next(1001)
numbers(ctr) = number
total += number
Next
numbers(3) = total
Dim values(numbers.Length - 1) As Object
numbers.CopyTo(values, 0)
Console.WriteLine("{0} + {1} + {2} = {3}", values)
End Sub
End Module
Samarbeta med oss på GitHub
Källan för det här innehållet finns på GitHub, där du även kan skapa och granska ärenden och pull-begäranden. Se vår deltagarguide för mer information.
