StringBuilder.AppendFormat Método
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação em cadeia de um argumento de objeto correspondente.
Sobrecargas
| Name | Description |
|---|---|
| AppendFormat(String, Object, Object, Object) |
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação em cadeia de um dos três argumentos. |
| AppendFormat(IFormatProvider, String, Object, Object) |
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação em cadeia de um de dois argumentos usando um fornecedor de formato especificado. |
| AppendFormat(String, Object, Object) |
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação em cadeia de qualquer um de dois argumentos. |
| AppendFormat(IFormatProvider, String, Object, Object, Object) |
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação de strings de qualquer um de três argumentos usando um fornecedor de formato especificado. |
| AppendFormat(IFormatProvider, String, Object) |
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação em cadeia de um único argumento usando um fornecedor de formato especificado. |
| AppendFormat(String, Object[]) |
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação em cadeia de um argumento correspondente num array de parâmetros. |
| AppendFormat(String, Object) |
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação da cadeia de um único argumento. |
| AppendFormat(IFormatProvider, String, Object[]) |
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação de string de um argumento correspondente num array de parâmetros usando um fornecedor de formato especificado. |
AppendFormat(String, Object, Object, Object)
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação em cadeia de um dos três argumentos.
public:
System::Text::StringBuilder ^ AppendFormat(System::String ^ format, System::Object ^ arg0, System::Object ^ arg1, System::Object ^ arg2);
public System.Text.StringBuilder AppendFormat(string format, object arg0, object arg1, object arg2);
member this.AppendFormat : string * obj * obj * obj -> System.Text.StringBuilder
Public Function AppendFormat (format As String, arg0 As Object, arg1 As Object, arg2 As Object) As StringBuilder
Parâmetros
- format
- String
Uma cadeia de formato composto.
- arg0
- Object
O primeiro objeto a formatar.
- arg1
- Object
O segundo objetivo é formatar.
- arg2
- Object
O terceiro objetivo a formatar.
Devoluções
Uma referência a esta instância com format anexo. Cada item de formato em format é substituído pela representação da cadeia de caracteres do argumento do objeto correspondente.
Exceções
format é null.
format é inválido.
-ou-
O índice de um item de formato é inferior a 0 (zero), ou maior ou igual a 3.
O comprimento da corda expandida excederia MaxCapacity.
Exemplos
O exemplo seguinte demonstra o AppendFormat método.
using System;
using System.Text;
using System.Globalization;
class Sample
{
static StringBuilder sb = new StringBuilder();
public static void Main()
{
int var1 = 111;
float var2 = 2.22F;
string var3 = "abcd";
object[] var4 = {3, 4.4, 'X'};
Console.WriteLine();
Console.WriteLine("StringBuilder.AppendFormat method:");
sb.AppendFormat("1) {0}", var1);
Show(sb);
sb.AppendFormat("2) {0}, {1}", var1, var2);
Show(sb);
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
Show(sb);
sb.AppendFormat("4) {0}, {1}, {2}", var4);
Show(sb);
CultureInfo ci = new CultureInfo("es-ES", true);
sb.AppendFormat(ci, "5) {0}", var2);
Show(sb);
}
public static void Show(StringBuilder sbs)
{
Console.WriteLine(sbs.ToString());
sb.Length = 0;
}
}
/*
This example produces the following results:
StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
open System.Text
open System.Globalization
let sb = StringBuilder()
let show (sbs: StringBuilder) =
printfn $"{sbs}"
sb.Length <- 0
let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]
printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb
// This example produces the following results:
// StringBuilder.AppendFormat method:
// 1) 111
// 2) 111, 2.22
// 3) 111, 2.22, abcd
// 4) 3, 4.4, X
// 5) 2,22
Imports System.Text
Imports System.Globalization
Class Sample
Private Shared sb As New StringBuilder()
Public Shared Sub Main()
Dim var1 As Integer = 111
Dim var2 As Single = 2.22F
Dim var3 As String = "abcd"
Dim var4 As Object() = {3, 4.4, "X"c}
Console.WriteLine()
Console.WriteLine("StringBuilder.AppendFormat method:")
sb.AppendFormat("1) {0}", var1)
Show(sb)
sb.AppendFormat("2) {0}, {1}", var1, var2)
Show(sb)
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
Show(sb)
sb.AppendFormat("4) {0}, {1}, {2}", var4)
Show(sb)
Dim ci As New CultureInfo("es-ES", True)
sb.AppendFormat(ci, "5) {0}", var2)
Show(sb)
End Sub
Public Shared Sub Show(sbs As StringBuilder)
Console.WriteLine(sbs.ToString())
sb.Length = 0
End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22
Observações
Este método utiliza a funcionalidade de formatação composite do .NET Framework para converter o valor de um objeto para a sua representação em texto e incorporar essa representação no objeto atual StringBuilder.
O format parâmetro consiste em zero ou mais sequências de texto misturadas com zero ou mais marcadores de posição indexados, chamados itens de formato, que correspondem até arg0arg2, aos objetos na lista de parâmetros deste método. O processo de formatação substitui cada item de formato pela representação em cadeia do objeto correspondente.
A sintaxe de um item de formato é a seguinte:
{index[,length][:formatString]}
Os elementos entre parênteses retos são opcionais. A tabela a seguir descreve cada elemento.
| Elemento | Description |
|---|---|
| índice | A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado pelo índice for null, o item de formato é substituído por String.Empty. Se não houver parâmetro na posição do índice , a FormatException é lançado. |
| ,comprimento | O número mínimo de caracteres na representação string do parâmetro. Se for positivo, o parâmetro está alinhado à direita; se for negativo, está alinhado à esquerda. |
| :formatString | Uma string de formato padrão ou personalizado suportada pelo parâmetro. |
Note
Para as cadeias de formatos padrão e personalizadas usadas com valores de data e hora, veja Cadeias de Formato de Data e Hora Padrão e Cadeias de Formato de Data e Hora Personalizadas. Para as cadeias de formatos padrão e personalizadas usadas com valores numéricos, veja Cadeias de Formato Numérico Padrão e Cadeias de Formato Numérico Personalizado. Para as cadeias de formato padrão usadas com enumerações, veja Strings de Formato de Enumeração.
arg0, arg1, e arg2 representam os objetos a serem formatados. Cada elemento de formato em format é substituído pela representação em cadeia de , arg0arg1, ou arg2, dependendo do índice do item de formato. Se o item de formato incluir formatString e o objeto correspondente em args implementar a IFormattable interface, então argx.ToString(formatString, null) define a formatação, onde x é o índice do argumento. Caso contrário, argx.ToString() define a formatação.
Se a cadeia atribuída a format for "Obrigado pela sua doação de {0:####} latas de comida à nossa organização de caridade." e arg0 for um número inteiro com o valor 10, o valor de retorno será "Obrigado pela sua doação de 10 latas de comida à nossa organização de caridade."
Notas para Chamadores
No .NET Core e no .NET Framework 4.0 e versões posteriores, quando se instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento como a capacidade da instância StringBuilder podem crescer para além do valor da sua propriedade MaxCapacity. Isto pode acontecer especialmente quando chamas os Append(String) métodos e AppendFormat(String, Object) para acrescentar pequenas cadeias.
Ver também
- Tipos de Formatação em .NET
- Formatação composta
- Standard Numeric Format Strings (Cadeias de Formato Numérico Padrão)
- Cadeias de caracteres de formato numérico personalizado
- Cadeias de Formatos de Data e Hora Padrão
- Cadeias de Formato de Data e Hora Personalizadas
- Cadeias de caracteres de formato TimeSpan padrão
- Cadeias de caracteres de formato TimeSpan personalizadas
- Cadeias de caracteres de formato de enumeração
Aplica-se a
AppendFormat(IFormatProvider, String, Object, Object)
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação em cadeia de um de dois argumentos usando um fornecedor de formato especificado.
public:
System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::String ^ format, System::Object ^ arg0, System::Object ^ arg1);
public System.Text.StringBuilder AppendFormat(IFormatProvider provider, string format, object arg0, object arg1);
member this.AppendFormat : IFormatProvider * string * obj * obj -> System.Text.StringBuilder
Public Function AppendFormat (provider As IFormatProvider, format As String, arg0 As Object, arg1 As Object) As StringBuilder
Parâmetros
- provider
- IFormatProvider
Um objeto que fornece informação de formatação específica para cada cultura.
- format
- String
Uma cadeia de formato composto.
- arg0
- Object
O primeiro objeto a formatar.
- arg1
- Object
O segundo objetivo é formatar.
Devoluções
Uma referência a esta instância após a conclusão da operação de anexação. Após a operação de anexação, esta instância contém quaisquer dados que existissem antes da operação, sufixados por uma cópia de format onde qualquer especificação de formato é substituída pela representação da cadeia do argumento do objeto correspondente.
Exceções
format é null.
format é inválido.
-ou-
O índice de um item de formato é inferior a 0 (zero), ou maior ou igual a 2 (dois).
O comprimento da corda expandida excederia MaxCapacity.
Exemplos
O exemplo seguinte utiliza o AppendFormat(IFormatProvider, String, Object, Object) método para exibir dados de tempo e temperatura armazenados num objeto genérico Dictionary<TKey,TValue> . Note que a cadeia de formato tem três itens de formatação, embora haja apenas dois objetos a formatar. Isto deve-se ao facto de o primeiro objeto da lista (um valor de data e hora) ser usado por dois itens de formato: o primeiro elemento de formato mostra a hora e o segundo mostra a data.
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Text;
public class Example
{
public static void Main()
{
CultureInfo culture = new CultureInfo("en-US");
StringBuilder sb = new StringBuilder();
Dictionary<DateTime, Double> temperatureInfo = new Dictionary<DateTime, Double>();
temperatureInfo.Add(new DateTime(2010, 6, 1, 14, 0, 0), 87.46);
temperatureInfo.Add(new DateTime(2010, 12, 1, 10, 0, 0), 36.81);
sb.AppendLine("Temperature Information:\n");
foreach (var item in temperatureInfo)
{
sb.AppendFormat(culture,
"Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F\n",
item.Key, item.Value);
}
Console.WriteLine(sb.ToString());
}
}
// The example displays the following output:
// Temperature Information:
//
// Temperature at 2:00 PM on 6/1/2010: 87.5°F
// Temperature at 10:00 AM on 12/1/2010: 36.8°F
open System
open System.Collections.Generic
open System.Globalization
open System.Text
let culture = CultureInfo "en-US"
let sb = StringBuilder()
let temperatureInfo = Dictionary<DateTime, Double>()
temperatureInfo.Add(DateTime(2010, 6, 1, 14, 0, 0), 87.46)
temperatureInfo.Add(DateTime(2010, 12, 1, 10, 0, 0), 36.81)
sb.AppendLine "Temperature Information:\n" |> ignore
for item in temperatureInfo do
sb.AppendFormat(culture, "Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F\n", item.Key, item.Value)
|> ignore
printfn $"{sb}"
// The example displays the following output:
// Temperature Information:
//
// Temperature at 2:00 PM on 6/1/2010: 87.5°F
// Temperature at 10:00 AM on 12/1/2010: 36.8°F
Imports System.Collections.Generic
Imports System.Globalization
Imports System.Text
Module Example
Public Sub Main()
Dim culture As New CultureInfo("en-US")
Dim sb As New StringBuilder()
Dim temperatureInfo As New Dictionary(Of Date, Double)
temperatureInfo.Add(#6/1/2010 2:00PM#, 87.46)
temperatureInfo.Add(#12/1/2010 10:00AM#, 36.81)
sb.AppendLine("Temperature Information:").AppendLine()
For Each item In temperatureInfo
sb.AppendFormat(culture,
"Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F",
item.Key, item.Value).AppendLine()
Next
Console.WriteLine(sb.ToString())
End Sub
End Module
' The example displays the following output:
' Temperature Information:
'
' Temperature at 2:00 PM on 6/1/2010: 87.5°F
' Temperature at 10:00 AM on 12/1/2010: 36.8°F
Observações
Este método utiliza a funcionalidade de formatação composite do .NET Framework para converter o valor de um objeto para a sua representação em texto e incorporar essa representação no objeto atual StringBuilder.
O format parâmetro consiste em zero ou mais sequências de texto misturadas com zero ou mais marcadores indexados, chamados itens de formato, que correspondem a objetos na lista de parâmetros deste método. O processo de formatação substitui cada item de formato pela representação em cadeia do objeto correspondente.
A sintaxe de um item de formato é a seguinte:
{index[,length][:formatString]}
Os elementos entre parênteses retos são opcionais. A tabela a seguir descreve cada elemento.
| Elemento | Description |
|---|---|
| índice | A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado pelo índice for null, o item de formato é substituído por String.Empty. Se não houver parâmetro na posição do índice , a FormatException é lançado. |
| ,comprimento | O número mínimo de caracteres na representação string do parâmetro. Se for positivo, o parâmetro está alinhado à direita; se for negativo, está alinhado à esquerda. |
| :formatString | Uma string de formato padrão ou personalizado suportada pelo parâmetro. |
Note
Para as cadeias de formatos padrão e personalizadas usadas com valores de data e hora, veja Cadeias de Formato de Data e Hora Padrão e Cadeias de Formato de Data e Hora Personalizadas. Para as cadeias de formatos padrão e personalizadas usadas com valores numéricos, veja Cadeias de Formato Numérico Padrão e Cadeias de Formato Numérico Personalizado. Para as cadeias de formato padrão usadas com enumerações, veja Strings de Formato de Enumeração.
O provider parâmetro especifica uma IFormatProvider implementação que pode fornecer informação de formatação para arg0 e arg1.
provider pode ser qualquer um dos seguintes:
Um objeto que fornece informação de formatação específica para CultureInfo cada cultura.
Um NumberFormatInfo objeto que fornece informação de formatação específica da cultura para
arg0ouarg1se forem valores numéricos.Um objeto que fornece informação de formatação específica da cultura para
arg0ouarg1se forem valores de DateTimeFormatInfo data e hora.Uma implementação personalizada IFormatProvider que fornece informação de formatação para
arg0earg1. Normalmente, tal implementação também implementa a ICustomFormatter interface.
Se o provider parâmetro for null, a informação do fornecedor de formato é obtida a partir da cultura atual.
arg0 e arg1 representam os objetos a serem formatados. Cada item de formato em format é substituído pela representação string do objeto que tem o índice correspondente. Se o item de formato incluir formatString e o argumento correspondente implementar a IFormattable interface, então o método do ToString(formatString, provider) argumento define a formatação. Caso contrário, o método do ToString() argumento define a formatação.
Notas para Chamadores
No .NET Core e no .NET Framework 4.0 e versões posteriores, quando se instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento como a capacidade da instância StringBuilder podem crescer para além do valor da sua propriedade MaxCapacity. Isto pode acontecer especialmente quando chamas os Append(String) métodos e AppendFormat(String, Object) para acrescentar pequenas cadeias.
Ver também
- Tipos de Formatação em .NET
- Formatação composta
- Como: Definir e Utilizar Fornecedores de Formatos Numéricos Personalizados
- Standard Numeric Format Strings (Cadeias de Formato Numérico Padrão)
- Cadeias de caracteres de formato numérico personalizado
- Cadeias de Formatos de Data e Hora Padrão
- Cadeias de Formato de Data e Hora Personalizadas
- Cadeias de caracteres de formato TimeSpan padrão
- Cadeias de caracteres de formato TimeSpan personalizadas
- Cadeias de caracteres de formato de enumeração
Aplica-se a
AppendFormat(String, Object, Object)
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação em cadeia de qualquer um de dois argumentos.
public:
System::Text::StringBuilder ^ AppendFormat(System::String ^ format, System::Object ^ arg0, System::Object ^ arg1);
public System.Text.StringBuilder AppendFormat(string format, object arg0, object arg1);
member this.AppendFormat : string * obj * obj -> System.Text.StringBuilder
Public Function AppendFormat (format As String, arg0 As Object, arg1 As Object) As StringBuilder
Parâmetros
- format
- String
Uma cadeia de formato composto.
- arg0
- Object
O primeiro objeto a formatar.
- arg1
- Object
O segundo objetivo é formatar.
Devoluções
Uma referência a esta instância com format anexo. Cada item de formato em format é substituído pela representação da cadeia de caracteres do argumento do objeto correspondente.
Exceções
format é null.
format é inválido.
-ou-
O índice de um item de formato é inferior a 0 (zero), ou maior ou igual a 2.
O comprimento da corda expandida excederia MaxCapacity.
Exemplos
O exemplo seguinte demonstra o AppendFormat método.
using System;
using System.Text;
using System.Globalization;
class Sample
{
static StringBuilder sb = new StringBuilder();
public static void Main()
{
int var1 = 111;
float var2 = 2.22F;
string var3 = "abcd";
object[] var4 = {3, 4.4, 'X'};
Console.WriteLine();
Console.WriteLine("StringBuilder.AppendFormat method:");
sb.AppendFormat("1) {0}", var1);
Show(sb);
sb.AppendFormat("2) {0}, {1}", var1, var2);
Show(sb);
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
Show(sb);
sb.AppendFormat("4) {0}, {1}, {2}", var4);
Show(sb);
CultureInfo ci = new CultureInfo("es-ES", true);
sb.AppendFormat(ci, "5) {0}", var2);
Show(sb);
}
public static void Show(StringBuilder sbs)
{
Console.WriteLine(sbs.ToString());
sb.Length = 0;
}
}
/*
This example produces the following results:
StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
open System.Text
open System.Globalization
let sb = StringBuilder()
let show (sbs: StringBuilder) =
printfn $"{sbs}"
sb.Length <- 0
let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]
printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb
// This example produces the following results:
// StringBuilder.AppendFormat method:
// 1) 111
// 2) 111, 2.22
// 3) 111, 2.22, abcd
// 4) 3, 4.4, X
// 5) 2,22
Imports System.Text
Imports System.Globalization
Class Sample
Private Shared sb As New StringBuilder()
Public Shared Sub Main()
Dim var1 As Integer = 111
Dim var2 As Single = 2.22F
Dim var3 As String = "abcd"
Dim var4 As Object() = {3, 4.4, "X"c}
Console.WriteLine()
Console.WriteLine("StringBuilder.AppendFormat method:")
sb.AppendFormat("1) {0}", var1)
Show(sb)
sb.AppendFormat("2) {0}, {1}", var1, var2)
Show(sb)
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
Show(sb)
sb.AppendFormat("4) {0}, {1}, {2}", var4)
Show(sb)
Dim ci As New CultureInfo("es-ES", True)
sb.AppendFormat(ci, "5) {0}", var2)
Show(sb)
End Sub
Public Shared Sub Show(sbs As StringBuilder)
Console.WriteLine(sbs.ToString())
sb.Length = 0
End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22
Observações
Este método utiliza a funcionalidade de formatação composite do .NET Framework para converter o valor de um objeto para a sua representação em texto e incorporar essa representação no objeto atual StringBuilder.
O format parâmetro consiste em zero ou mais sequências de texto misturadas com zero ou mais marcadores indexados, chamados itens de formato, que correspondem a arg0 e arg1, os dois objetos na lista de parâmetros deste método. O processo de formatação substitui cada item de formato pela representação em cadeia do objeto correspondente.
A sintaxe de um item de formato é a seguinte:
{index[,length][:formatString]}
Os elementos entre parênteses retos são opcionais. A tabela a seguir descreve cada elemento.
| Elemento | Description |
|---|---|
| índice | A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado pelo índice for null, o item de formato é substituído por String.Empty. Se não houver parâmetro na posição do índice , a FormatException é lançado. |
| ,comprimento | O número mínimo de caracteres na representação string do parâmetro. Se for positivo, o parâmetro está alinhado à direita; se for negativo, está alinhado à esquerda. |
| :formatString | Uma string de formato padrão ou personalizado suportada pelo parâmetro. |
Note
Para as cadeias de formatos padrão e personalizadas usadas com valores de data e hora, veja Cadeias de Formato de Data e Hora Padrão e Cadeias de Formato de Data e Hora Personalizadas. Para as cadeias de formatos padrão e personalizadas usadas com valores numéricos, veja Cadeias de Formato Numérico Padrão e Cadeias de Formato Numérico Personalizado. Para as cadeias de formato padrão usadas com enumerações, veja Strings de Formato de Enumeração.
arg0 e arg1 representam os objetos a serem formatados. Cada item de formato em format é substituído pela representação em cadeia de ou arg0arg1. Se o item de formato incluir formatString e o objeto correspondente implementar a IFormattable interface, então argx.ToString(formatString, provider) define a formatação, onde x é o índice do argumento. Caso contrário, argx.ToString() define a formatação.
Se a cadeia atribuída a format for "Obrigado pela sua doação de {0:####} latas de comida à nossa organização de caridade." e arg0 for um número inteiro com o valor 10, o valor de retorno será "Obrigado pela sua doação de 10 latas de comida à nossa organização de caridade."
Notas para Chamadores
No .NET Core e no .NET Framework 4.0 e versões posteriores, quando se instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento como a capacidade da instância StringBuilder podem crescer para além do valor da sua propriedade MaxCapacity. Isto pode acontecer especialmente quando chamas os Append(String) métodos e AppendFormat(String, Object) para acrescentar pequenas cadeias.
Ver também
- Tipos de Formatação em .NET
- Formatação composta
- Standard Numeric Format Strings (Cadeias de Formato Numérico Padrão)
- Cadeias de caracteres de formato numérico personalizado
- Cadeias de Formatos de Data e Hora Padrão
- Cadeias de Formato de Data e Hora Personalizadas
- Cadeias de caracteres de formato TimeSpan padrão
- Cadeias de caracteres de formato TimeSpan personalizadas
- Cadeias de caracteres de formato de enumeração
Aplica-se a
AppendFormat(IFormatProvider, String, Object, Object, Object)
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação de strings de qualquer um de três argumentos usando um fornecedor de formato especificado.
public:
System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::String ^ format, System::Object ^ arg0, System::Object ^ arg1, System::Object ^ arg2);
public System.Text.StringBuilder AppendFormat(IFormatProvider provider, string format, object arg0, object arg1, object arg2);
member this.AppendFormat : IFormatProvider * string * obj * obj * obj -> System.Text.StringBuilder
Public Function AppendFormat (provider As IFormatProvider, format As String, arg0 As Object, arg1 As Object, arg2 As Object) As StringBuilder
Parâmetros
- provider
- IFormatProvider
Um objeto que fornece informação de formatação específica para cada cultura.
- format
- String
Uma cadeia de formato composto.
- arg0
- Object
O primeiro objeto a formatar.
- arg1
- Object
O segundo objetivo é formatar.
- arg2
- Object
O terceiro objetivo a formatar.
Devoluções
Uma referência a esta instância após a conclusão da operação de anexação. Após a operação de anexação, esta instância contém quaisquer dados que existissem antes da operação, sufixados por uma cópia de format onde qualquer especificação de formato é substituída pela representação da cadeia do argumento do objeto correspondente.
Exceções
format é null.
format é inválido.
-ou-
O índice de um item de formato é inferior a 0 (zero), ou maior ou igual a 3 (três).
O comprimento da corda expandida excederia MaxCapacity.
Exemplos
O exemplo seguinte utiliza o AppendFormat(IFormatProvider, String, Object, Object, Object) método para ilustrar o resultado de uma operação booleana And com valores inteiros. Note-se que a string de formato inclui seis itens de formato, mas o método tem apenas três itens na sua lista de argumentos, porque cada item está formatado de duas formas diferentes.
using System;
using System.Globalization;
using System.Text;
public class Example
{
public static void Main()
{
Random rnd = new Random();
CultureInfo culture = CultureInfo.CreateSpecificCulture("fr-FR");
StringBuilder sb = new StringBuilder();
string formatString = " {0,12:N0} ({0,8:X8})\n" +
"And {1,12:N0} ({1,8:X8})\n" +
" = {2,12:N0} ({2,8:X8})\n";
for (int ctr = 0; ctr <= 2; ctr++) {
int value1 = rnd.Next();
int value2 = rnd.Next();
sb.AppendFormat(culture, formatString,
value1, value2, value1 & value2).
AppendLine();
}
Console.WriteLine(sb.ToString());
}
}
// The example displays output like the following:
// 1 984 112 195 (76432643)
// And 1 179 778 511 (4651FDCF)
// = 1 178 674 243 (46412443)
//
// 2 034 813 710 (7948CB0E)
// And 569 333 976 (21EF58D8)
// = 558 385 160 (21484808)
//
// 126 717 735 (078D8F27)
// And 1 830 715 973 (6D1E8245)
// = 84 705 797 (050C8205)
open System
open System.Globalization
open System.Text
let rnd = Random()
let culture = CultureInfo.CreateSpecificCulture "fr-FR"
let sb = StringBuilder()
let formatString =
" {0,12:N0} ({0,8:X8})\nAnd {1,12:N0} ({1,8:X8})\n = {2,12:N0} ({2,8:X8})\n"
for _ = 0 to 2 do
let value1 = rnd.Next()
let value2 = rnd.Next()
sb
.AppendFormat(culture, formatString, value1, value2, value1 &&& value2)
.AppendLine()
|> ignore
printfn $"{sb}"
// The example displays output like the following:
// 1 984 112 195 (76432643)
// And 1 179 778 511 (4651FDCF)
// = 1 178 674 243 (46412443)
//
// 2 034 813 710 (7948CB0E)
// And 569 333 976 (21EF58D8)
// = 558 385 160 (21484808)
//
// 126 717 735 (078D8F27)
// And 1 830 715 973 (6D1E8245)
// = 84 705 797 (050C8205)
Imports System.Globalization
Imports System.Text
Public Module Example
Public Sub Main()
Dim rnd As New Random()
Dim culture As CultureInfo = CultureInfo.CreateSpecificCulture("fr-FR")
Dim sb As New StringBuilder()
Dim formatString As String = " {0,12:N0} ({0,8:X8})" + vbCrLf +
"And {1,12:N0} ({1,8:X8})" + vbCrLf +
" = {2,12:N0} ({2,8:X8})" + vbCrLf
For ctr As Integer = 0 To 2
Dim value1 As Integer = rnd.Next()
Dim value2 As Integer = rnd.Next()
sb.AppendFormat(culture, formatString,
value1, value2, value1 And value2).AppendLine()
Next
Console.WriteLine(sb.ToString())
End Sub
End Module
' The example displays the following output:
' 1 984 112 195 (76432643)
' And 1 179 778 511 (4651FDCF)
' = 1 178 674 243 (46412443)
'
' 2 034 813 710 (7948CB0E)
' And 569 333 976 (21EF58D8)
' = 558 385 160 (21484808)
'
' 126 717 735 (078D8F27)
' And 1 830 715 973 (6D1E8245)
' = 84 705 797 (050C8205)
Observações
Este método utiliza a funcionalidade de formatação composite do .NET Framework para converter o valor de um objeto para a sua representação em texto e incorporar essa representação no objeto atual StringBuilder.
O format parâmetro consiste em zero ou mais sequências de texto misturadas com zero ou mais marcadores indexados, chamados itens de formato, que correspondem a objetos na lista de parâmetros deste método. O processo de formatação substitui cada item de formato pela representação em cadeia do objeto correspondente.
A sintaxe de um item de formato é a seguinte:
{index[,length][:formatString]}
Os elementos entre parênteses retos são opcionais. A tabela a seguir descreve cada elemento.
| Elemento | Description |
|---|---|
| índice | A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado pelo índice for null, o item de formato é substituído por String.Empty. Se não houver parâmetro na posição do índice , a FormatException é lançado. |
| ,comprimento | O número mínimo de caracteres na representação string do parâmetro. Se for positivo, o parâmetro está alinhado à direita; se for negativo, está alinhado à esquerda. |
| :formatString | Uma string de formato padrão ou personalizado suportada pelo parâmetro. |
Note
Para as cadeias de formatos padrão e personalizadas usadas com valores de data e hora, veja Cadeias de Formato de Data e Hora Padrão e Cadeias de Formato de Data e Hora Personalizadas. Para as cadeias de formatos padrão e personalizadas usadas com valores numéricos, veja Cadeias de Formato Numérico Padrão e Cadeias de Formato Numérico Personalizado. Para as cadeias de formato padrão usadas com enumerações, veja Strings de Formato de Enumeração.
O provider parâmetro especifica uma IFormatProvider implementação que pode fornecer informação de formatação para arg0 e arg1.
provider pode ser qualquer um dos seguintes:
Um objeto que fornece informação de formatação específica para CultureInfo cada cultura.
Um NumberFormatInfo objeto que fornece informação de formatação específica da cultura para
arg0ouarg1se forem valores numéricos.Um objeto que fornece informação de formatação específica para cultura para
arg0,arg1, ouarg2se forem valores de DateTimeFormatInfo data e hora.Uma implementação personalizada IFormatProvider que fornece informação de formatação para
arg0,arg1, earg2. Normalmente, tal implementação também implementa a ICustomFormatter interface.
Se o provider parâmetro for null, a informação do fornecedor de formato é obtida a partir da cultura atual.
arg0, arg1, e arg2 representam os objetos a serem formatados. Cada item de formato em format é substituído pela representação string do objeto que tem o índice correspondente. Se o item de formato incluir formatString e o argumento correspondente implementar a IFormattable interface, então o método do ToString(formatString, provider) argumento define a formatação. Caso contrário, o método do ToString() argumento define a formatação.
Notas para Chamadores
No .NET Core e no .NET Framework 4.0 e versões posteriores, quando se instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento como a capacidade da instância StringBuilder podem crescer para além do valor da sua propriedade MaxCapacity. Isto pode acontecer especialmente quando chamas os Append(String) métodos e AppendFormat(String, Object) para acrescentar pequenas cadeias.
Ver também
- Tipos de Formatação em .NET
- Formatação composta
- Como: Definir e Utilizar Fornecedores de Formatos Numéricos Personalizados
- Standard Numeric Format Strings (Cadeias de Formato Numérico Padrão)
- Cadeias de caracteres de formato numérico personalizado
- Cadeias de Formatos de Data e Hora Padrão
- Cadeias de Formato de Data e Hora Personalizadas
- Cadeias de caracteres de formato TimeSpan padrão
- Cadeias de caracteres de formato TimeSpan personalizadas
- Cadeias de caracteres de formato de enumeração
Aplica-se a
AppendFormat(IFormatProvider, String, Object)
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação em cadeia de um único argumento usando um fornecedor de formato especificado.
public:
System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::String ^ format, System::Object ^ arg0);
public System.Text.StringBuilder AppendFormat(IFormatProvider provider, string format, object arg0);
member this.AppendFormat : IFormatProvider * string * obj -> System.Text.StringBuilder
Public Function AppendFormat (provider As IFormatProvider, format As String, arg0 As Object) As StringBuilder
Parâmetros
- provider
- IFormatProvider
Um objeto que fornece informação de formatação específica para cada cultura.
- format
- String
Uma cadeia de formato composto.
- arg0
- Object
O objetivo a formatar.
Devoluções
Uma referência a esta instância após a conclusão da operação de anexação. Após a operação de anexação, esta instância contém quaisquer dados que existissem antes da operação, com sufixo de uma cópia de format em que qualquer especificação de formato é substituída pela representação de cadeia de arg0.
Exceções
format é null.
format é inválido.
-ou-
O índice de um item de formato é inferior a 0 (zero), ou maior ou igual a um (1).
O comprimento da corda expandida excederia MaxCapacity.
Exemplos
O seguinte inclui duas chamadas ao AppendFormat(IFormatProvider, String, Object) método. Ambos utilizam as convenções de formatação da cultura English-United Kingdom (en-GB). A primeira insere a representação da cadeia de uma Decimal moeda de valor numa cadeia de resultados. O segundo insere um DateTime valor em dois lugares numa cadeia de resultados, o primeiro incluindo apenas a sequência de data curta e o segundo a cadeia de tempo curto.
using System;
using System.Globalization;
using System.Text;
public class Example
{
public static void Main()
{
StringBuilder sb = new StringBuilder();
Decimal value = 16.95m;
CultureInfo enGB = CultureInfo.CreateSpecificCulture("en-GB");
DateTime dateToday = DateTime.Now;
sb.AppendFormat(enGB, "Final Price: {0:C2}", value);
sb.AppendLine();
sb.AppendFormat(enGB, "Date and Time: {0:d} at {0:t}", dateToday);
Console.WriteLine(sb.ToString());
}
}
// The example displays the following output:
// Final Price: £16.95
// Date and Time: 01/10/2014 at 10:22
open System
open System.Globalization
open System.Text
let sb = StringBuilder()
let value = 16.95m
let enGB = CultureInfo.CreateSpecificCulture "en-GB"
let dateToday = DateTime.Now
sb.AppendFormat(enGB, "Final Price: {0:C2}", value) |> ignore
sb.AppendLine() |> ignore
sb.AppendFormat(enGB, "Date and Time: {0:d} at {0:t}", dateToday) |> ignore
printfn $"{sb}"
// The example displays the following output:
// Final Price: £16.95
// Date and Time: 01/10/2014 at 10:22
Imports System.Globalization
Imports System.Text
Module Example
Public Sub Main()
Dim sb As New StringBuilder()
Dim value As Decimal = 16.95d
Dim enGB As CultureInfo = CultureInfo.CreateSpecificCulture("en-GB")
Dim dateToday As DateTime = Date.Now
sb.AppendFormat(enGB, "Final Price: {0:C2}", value)
sb.AppendLine()
sb.AppendFormat(enGB, "Date and Time: {0:d} at {0:t}", dateToday)
Console.WriteLine(sb.ToString())
End Sub
End Module
' The example displays output like the following:
' Final Price: £16.95
' Date and Time: 01/10/2014 at 10:22
Observações
Este método utiliza a funcionalidade de formatação composite do .NET Framework para converter o valor de arg0 para a sua representação em texto e incorporar essa representação no objeto StringBuilder atual.
O format parâmetro consiste em zero ou mais sequências de texto misturadas com zero ou mais marcadores indexados, chamados itens de formato. O índice de cada item de formato deve ser zero (0), uma vez que este método inclui uma lista de argumentos com um único argumento. O processo de formatação substitui cada item de formato pela representação em cadeia de arg0.
A sintaxe de um item de formato é a seguinte:
{index[,length][:formatString]}
Os elementos entre parênteses retos são opcionais. A tabela a seguir descreve cada elemento.
| Elemento | Description |
|---|---|
| índice | A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado pelo índice for null, o item de formato é substituído por String.Empty. Neste caso, como o AppendFormat(IFormatProvider, String, Object) método tem um único argumento na lista de argumentos, o valor do índice deve ser sempre 0. Se não for, lança-se a.FormatException |
| ,comprimento | O número mínimo de caracteres na representação string do parâmetro. Se for positivo, o parâmetro está alinhado à direita; se for negativo, está alinhado à esquerda. |
| :formatString | Uma string de formato padrão ou personalizado suportada pelo parâmetro. |
Note
Para as cadeias de formatos padrão e personalizadas usadas com valores de data e hora, veja Cadeias de Formato de Data e Hora Padrão e Cadeias de Formato de Data e Hora Personalizadas. Para as cadeias de formatos padrão e personalizadas usadas com valores numéricos, veja Cadeias de Formato Numérico Padrão e Cadeias de Formato Numérico Personalizado. Para as cadeias de formato padrão usadas com enumerações, veja Strings de Formato de Enumeração.
O provider parâmetro especifica uma IFormatProvider implementação que pode fornecer informação de formatação para os objetos em args.
provider pode ser qualquer um dos seguintes:
Um objeto que fornece informação de formatação específica para CultureInfo cada cultura.
Um objeto que fornece informação de formatação específica para NumberFormatInfo cultura, caso
arg0seja um valor numérico.Um DateTimeFormatInfo objeto que fornece informação de formatação específica da cultura para
arg0determinar se for um valor de data e hora.Uma implementação personalizada IFormatProvider que fornece informação de formatação para
arg0. Normalmente, tal implementação também implementa a ICustomFormatter interface.
Se o provider parâmetro for null, a informação de formatação é obtida a partir da cultura atual.
arg0 representa o objeto a ser formatado. Cada item de formato em format é substituído pela representação em cadeia de arg0. Se o item de formato incluir formatString e arg0 implementar a IFormattable interface, então arg0.ToString(formatString, provider) define a formatação. Caso contrário, arg0.ToString() define a formatação.
Notas para Chamadores
No .NET Core e no .NET Framework 4.0 e versões posteriores, quando se instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento como a capacidade da instância StringBuilder podem crescer para além do valor da sua propriedade MaxCapacity. Isto pode acontecer especialmente quando chamas os Append(String) métodos e AppendFormat(String, Object) para acrescentar pequenas cadeias.
Ver também
- Tipos de Formatação em .NET
- Formatação composta
- Como: Definir e Utilizar Fornecedores de Formatos Numéricos Personalizados
- Standard Numeric Format Strings (Cadeias de Formato Numérico Padrão)
- Cadeias de caracteres de formato numérico personalizado
- Cadeias de Formatos de Data e Hora Padrão
- Cadeias de Formato de Data e Hora Personalizadas
- Cadeias de caracteres de formato TimeSpan padrão
- Cadeias de caracteres de formato TimeSpan personalizadas
- Cadeias de caracteres de formato de enumeração
Aplica-se a
AppendFormat(String, Object[])
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação em cadeia de um argumento correspondente num array de parâmetros.
public:
System::Text::StringBuilder ^ AppendFormat(System::String ^ format, ... cli::array <System::Object ^> ^ args);
public System.Text.StringBuilder AppendFormat(string format, params object[] args);
member this.AppendFormat : string * obj[] -> System.Text.StringBuilder
Public Function AppendFormat (format As String, ParamArray args As Object()) As StringBuilder
Parâmetros
- format
- String
Uma cadeia de formato composto.
- args
- Object[]
Um conjunto de objetos para formatar.
Devoluções
Uma referência a esta instância com format anexo. Cada item de formato em format é substituído pela representação da cadeia de caracteres do argumento do objeto correspondente.
Exceções
format ou args é null.
format é inválido.
-ou-
O índice de um item de formato é inferior a 0 (zero), ou maior ou igual ao comprimento do args array.
O comprimento da corda expandida excederia MaxCapacity.
Exemplos
O exemplo seguinte demonstra o AppendFormat método.
using System;
using System.Text;
using System.Globalization;
class Sample
{
static StringBuilder sb = new StringBuilder();
public static void Main()
{
int var1 = 111;
float var2 = 2.22F;
string var3 = "abcd";
object[] var4 = {3, 4.4, 'X'};
Console.WriteLine();
Console.WriteLine("StringBuilder.AppendFormat method:");
sb.AppendFormat("1) {0}", var1);
Show(sb);
sb.AppendFormat("2) {0}, {1}", var1, var2);
Show(sb);
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
Show(sb);
sb.AppendFormat("4) {0}, {1}, {2}", var4);
Show(sb);
CultureInfo ci = new CultureInfo("es-ES", true);
sb.AppendFormat(ci, "5) {0}", var2);
Show(sb);
}
public static void Show(StringBuilder sbs)
{
Console.WriteLine(sbs.ToString());
sb.Length = 0;
}
}
/*
This example produces the following results:
StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
open System.Text
open System.Globalization
let sb = StringBuilder()
let show (sbs: StringBuilder) =
printfn $"{sbs}"
sb.Length <- 0
let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]
printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb
// This example produces the following results:
// StringBuilder.AppendFormat method:
// 1) 111
// 2) 111, 2.22
// 3) 111, 2.22, abcd
// 4) 3, 4.4, X
// 5) 2,22
Imports System.Text
Imports System.Globalization
Class Sample
Private Shared sb As New StringBuilder()
Public Shared Sub Main()
Dim var1 As Integer = 111
Dim var2 As Single = 2.22F
Dim var3 As String = "abcd"
Dim var4 As Object() = {3, 4.4, "X"c}
Console.WriteLine()
Console.WriteLine("StringBuilder.AppendFormat method:")
sb.AppendFormat("1) {0}", var1)
Show(sb)
sb.AppendFormat("2) {0}, {1}", var1, var2)
Show(sb)
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
Show(sb)
sb.AppendFormat("4) {0}, {1}, {2}", var4)
Show(sb)
Dim ci As New CultureInfo("es-ES", True)
sb.AppendFormat(ci, "5) {0}", var2)
Show(sb)
End Sub
Public Shared Sub Show(sbs As StringBuilder)
Console.WriteLine(sbs.ToString())
sb.Length = 0
End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22
Observações
Este método utiliza a funcionalidade de formatação composite do .NET Framework para converter o valor de um objeto para a sua representação em texto e incorporar essa representação no objeto atual StringBuilder.
O format parâmetro consiste em zero ou mais sequências de texto misturadas com zero ou mais marcadores indexados, chamados itens de formato, que correspondem a objetos na lista de parâmetros deste método. O processo de formatação substitui cada item de formato pela representação em cadeia do objeto correspondente.
A sintaxe de um item de formato é a seguinte:
{index[,length][:formatString]}
Os elementos entre parênteses retos são opcionais. A tabela a seguir descreve cada elemento.
| Elemento | Description |
|---|---|
| índice | A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado pelo índice for null, o item de formato é substituído por String.Empty. Se não houver parâmetro na posição do índice , a FormatException é lançado. |
| ,comprimento | O número mínimo de caracteres na representação string do parâmetro. Se for positivo, o parâmetro está alinhado à direita; se for negativo, está alinhado à esquerda. |
| :formatString | Uma string de formato padrão ou personalizado suportada pelo parâmetro. |
Note
Para as cadeias de formatos padrão e personalizadas usadas com valores de data e hora, veja Cadeias de Formato de Data e Hora Padrão e Cadeias de Formato de Data e Hora Personalizadas. Para as cadeias de formatos padrão e personalizadas usadas com valores numéricos, veja Cadeias de Formato Numérico Padrão e Cadeias de Formato Numérico Personalizado. Para as cadeias de formato padrão usadas com enumerações, veja Strings de Formato de Enumeração.
args representa os objetos a formatar. Cada item de formato em format é substituído pela representação em cadeia do objeto correspondente em args. Se o item de formato incluir formatString e o objeto correspondente em args implementar a IFormattable interface, então args[index].ToString(formatString, provider) define a formatação. Caso contrário, args[index].ToString() define a formatação.
Se a cadeia atribuída a format for "Obrigado pela sua doação de {0:####} latas de comida à nossa organização de caridade." e arg0 for um número inteiro com o valor 10, o valor de retorno será "Obrigado pela sua doação de 10 latas de comida à nossa organização de caridade."
Notas para Chamadores
No .NET Core e no .NET Framework 4.0 e versões posteriores, quando se instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento como a capacidade da instância StringBuilder podem crescer para além do valor da sua propriedade MaxCapacity. Isto pode acontecer especialmente quando chamas os Append(String) métodos e AppendFormat(String, Object) para acrescentar pequenas cadeias.
Ver também
- Tipos de Formatação em .NET
- Formatação composta
- Standard Numeric Format Strings (Cadeias de Formato Numérico Padrão)
- Cadeias de caracteres de formato numérico personalizado
- Cadeias de Formatos de Data e Hora Padrão
- Cadeias de Formato de Data e Hora Personalizadas
- Cadeias de caracteres de formato TimeSpan padrão
- Cadeias de caracteres de formato TimeSpan personalizadas
- Cadeias de caracteres de formato de enumeração
Aplica-se a
AppendFormat(String, Object)
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação da cadeia de um único argumento.
public:
System::Text::StringBuilder ^ AppendFormat(System::String ^ format, System::Object ^ arg0);
public System.Text.StringBuilder AppendFormat(string format, object arg0);
member this.AppendFormat : string * obj -> System.Text.StringBuilder
Public Function AppendFormat (format As String, arg0 As Object) As StringBuilder
Parâmetros
- format
- String
Uma cadeia de formato composto.
- arg0
- Object
Um objeto a formatar.
Devoluções
Uma referência a esta instância com format anexo. Cada item de formato em format é substituído pela representação da cadeia de arg0.
Exceções
format é null.
format é inválido.
-ou-
O índice de um item de formato é menor que 0 (zero), ou maior ou igual a 1.
O comprimento da corda expandida excederia MaxCapacity.
Exemplos
O exemplo seguinte demonstra o AppendFormat método.
using System;
using System.Text;
using System.Globalization;
class Sample
{
static StringBuilder sb = new StringBuilder();
public static void Main()
{
int var1 = 111;
float var2 = 2.22F;
string var3 = "abcd";
object[] var4 = {3, 4.4, 'X'};
Console.WriteLine();
Console.WriteLine("StringBuilder.AppendFormat method:");
sb.AppendFormat("1) {0}", var1);
Show(sb);
sb.AppendFormat("2) {0}, {1}", var1, var2);
Show(sb);
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
Show(sb);
sb.AppendFormat("4) {0}, {1}, {2}", var4);
Show(sb);
CultureInfo ci = new CultureInfo("es-ES", true);
sb.AppendFormat(ci, "5) {0}", var2);
Show(sb);
}
public static void Show(StringBuilder sbs)
{
Console.WriteLine(sbs.ToString());
sb.Length = 0;
}
}
/*
This example produces the following results:
StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
open System.Text
open System.Globalization
let sb = StringBuilder()
let show (sbs: StringBuilder) =
printfn $"{sbs}"
sb.Length <- 0
let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]
printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb
// This example produces the following results:
// StringBuilder.AppendFormat method:
// 1) 111
// 2) 111, 2.22
// 3) 111, 2.22, abcd
// 4) 3, 4.4, X
// 5) 2,22
Imports System.Text
Imports System.Globalization
Class Sample
Private Shared sb As New StringBuilder()
Public Shared Sub Main()
Dim var1 As Integer = 111
Dim var2 As Single = 2.22F
Dim var3 As String = "abcd"
Dim var4 As Object() = {3, 4.4, "X"c}
Console.WriteLine()
Console.WriteLine("StringBuilder.AppendFormat method:")
sb.AppendFormat("1) {0}", var1)
Show(sb)
sb.AppendFormat("2) {0}, {1}", var1, var2)
Show(sb)
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
Show(sb)
sb.AppendFormat("4) {0}, {1}, {2}", var4)
Show(sb)
Dim ci As New CultureInfo("es-ES", True)
sb.AppendFormat(ci, "5) {0}", var2)
Show(sb)
End Sub
Public Shared Sub Show(sbs As StringBuilder)
Console.WriteLine(sbs.ToString())
sb.Length = 0
End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22
Observações
Este método utiliza a funcionalidade de formatação composite do .NET Framework para converter o valor de um objeto para a sua representação em texto e incorporar essa representação no objeto atual StringBuilder.
O format parâmetro consiste em zero ou mais sequências de texto misturadas com zero ou mais marcadores indexados, chamados itens de formato. O índice dos itens de formato deve ser 0, para corresponder a arg0, o único objeto na lista de parâmetros deste método. O processo de formatação substitui cada item de formato pela representação em cadeia de arg0.
A sintaxe de um item de formato é a seguinte:
{index[,length][:formatString]}
Os elementos entre parênteses retos são opcionais. A tabela a seguir descreve cada elemento.
| Elemento | Description |
|---|---|
| índice | A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado pelo índice for null, o item de formato é substituído por String.Empty. Se não houver parâmetro na posição do índice , a FormatException é lançado. |
| ,comprimento | O número mínimo de caracteres na representação string do parâmetro. Se for positivo, o parâmetro está alinhado à direita; se for negativo, está alinhado à esquerda. |
| :formatString | Uma string de formato padrão ou personalizado suportada pelo parâmetro. |
Note
Para as cadeias de formatos padrão e personalizadas usadas com valores de data e hora, veja Cadeias de Formato de Data e Hora Padrão e Cadeias de Formato de Data e Hora Personalizadas. Para as cadeias de formatos padrão e personalizadas usadas com valores numéricos, veja Cadeias de Formato Numérico Padrão e Cadeias de Formato Numérico Personalizado. Para as cadeias de formato padrão usadas com enumerações, veja Strings de Formato de Enumeração.
arg0 representa o objeto a ser formatado. Cada item de formato em format é substituído pela representação em cadeia de arg0. Se o item de formato incluir formatString e arg0 implementar a IFormattable interface, então arg0.ToString(formatString, null) define a formatação. Caso contrário, arg0.ToString() define a formatação.
Se a cadeia atribuída a format for "Obrigado pela sua doação de {0:####} latas de comida à nossa organização de caridade." e arg0 for um número inteiro com o valor 10, o valor de retorno será "Obrigado pela sua doação de 10 latas de comida à nossa organização de caridade."
Notas para Chamadores
No .NET Core e no .NET Framework 4.0 e versões posteriores, quando se instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento como a capacidade da instância StringBuilder podem crescer para além do valor da sua propriedade MaxCapacity. Isto pode acontecer especialmente quando chamas os Append(String) métodos e AppendFormat(String, Object) para acrescentar pequenas cadeias.
Ver também
- Tipos de Formatação em .NET
- Formatação composta
- Standard Numeric Format Strings (Cadeias de Formato Numérico Padrão)
- Cadeias de caracteres de formato numérico personalizado
- Cadeias de Formatos de Data e Hora Padrão
- Cadeias de Formato de Data e Hora Personalizadas
- Cadeias de caracteres de formato TimeSpan padrão
- Cadeias de caracteres de formato TimeSpan personalizadas
- Cadeias de caracteres de formato de enumeração
Aplica-se a
AppendFormat(IFormatProvider, String, Object[])
Adiciona a cadeia devolvida ao processar uma cadeia de formato composto, que contém zero ou mais itens de formato, a esta instância. Cada item de formato é substituído pela representação de string de um argumento correspondente num array de parâmetros usando um fornecedor de formato especificado.
public:
System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::String ^ format, ... cli::array <System::Object ^> ^ args);
public System.Text.StringBuilder AppendFormat(IFormatProvider provider, string format, params object[] args);
member this.AppendFormat : IFormatProvider * string * obj[] -> System.Text.StringBuilder
Public Function AppendFormat (provider As IFormatProvider, format As String, ParamArray args As Object()) As StringBuilder
Parâmetros
- provider
- IFormatProvider
Um objeto que fornece informação de formatação específica para cada cultura.
- format
- String
Uma cadeia de formato composto.
- args
- Object[]
Um conjunto de objetos para formatar.
Devoluções
Uma referência a esta instância após a conclusão da operação de anexação. Após a operação de anexação, esta instância contém quaisquer dados que existissem antes da operação, sufixados por uma cópia de format onde qualquer especificação de formato é substituída pela representação da cadeia do argumento do objeto correspondente.
Exceções
format é null.
format é inválido.
-ou-
O índice de um item de formato é inferior a 0 (zero), ou maior ou igual ao comprimento do args array.
O comprimento da corda expandida excederia MaxCapacity.
Exemplos
O exemplo seguinte demonstra o AppendFormat método.
using System;
using System.Text;
using System.Globalization;
class Sample
{
static StringBuilder sb = new StringBuilder();
public static void Main()
{
int var1 = 111;
float var2 = 2.22F;
string var3 = "abcd";
object[] var4 = {3, 4.4, 'X'};
Console.WriteLine();
Console.WriteLine("StringBuilder.AppendFormat method:");
sb.AppendFormat("1) {0}", var1);
Show(sb);
sb.AppendFormat("2) {0}, {1}", var1, var2);
Show(sb);
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
Show(sb);
sb.AppendFormat("4) {0}, {1}, {2}", var4);
Show(sb);
CultureInfo ci = new CultureInfo("es-ES", true);
sb.AppendFormat(ci, "5) {0}", var2);
Show(sb);
}
public static void Show(StringBuilder sbs)
{
Console.WriteLine(sbs.ToString());
sb.Length = 0;
}
}
/*
This example produces the following results:
StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
open System.Text
open System.Globalization
let sb = StringBuilder()
let show (sbs: StringBuilder) =
printfn $"{sbs}"
sb.Length <- 0
let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]
printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb
// This example produces the following results:
// StringBuilder.AppendFormat method:
// 1) 111
// 2) 111, 2.22
// 3) 111, 2.22, abcd
// 4) 3, 4.4, X
// 5) 2,22
Imports System.Text
Imports System.Globalization
Class Sample
Private Shared sb As New StringBuilder()
Public Shared Sub Main()
Dim var1 As Integer = 111
Dim var2 As Single = 2.22F
Dim var3 As String = "abcd"
Dim var4 As Object() = {3, 4.4, "X"c}
Console.WriteLine()
Console.WriteLine("StringBuilder.AppendFormat method:")
sb.AppendFormat("1) {0}", var1)
Show(sb)
sb.AppendFormat("2) {0}, {1}", var1, var2)
Show(sb)
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
Show(sb)
sb.AppendFormat("4) {0}, {1}, {2}", var4)
Show(sb)
Dim ci As New CultureInfo("es-ES", True)
sb.AppendFormat(ci, "5) {0}", var2)
Show(sb)
End Sub
Public Shared Sub Show(sbs As StringBuilder)
Console.WriteLine(sbs.ToString())
sb.Length = 0
End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22
O exemplo seguinte define uma implementação personalizada IFormatProvider chamada CustomerFormatter que formata um número de cliente de 10 dígitos com hífens após o quarto e o sétimo dígitos. É passado ao StringBuilder.AppendFormat(IFormatProvider, String, Object[]) método para criar uma cadeia que inclui o número do cliente formatado e o nome do cliente.
using System;
using System.Text;
public class Customer
{
private string custName;
private int custNumber;
public Customer(string name, int number)
{
this.custName = name;
this.custNumber = number;
}
public string Name
{
get { return this.custName; }
}
public int CustomerNumber
{
get { return this.custNumber; }
}
}
public class CustomerNumberFormatter : IFormatProvider, ICustomFormatter
{
public object GetFormat(Type formatType)
{
if (formatType == typeof(ICustomFormatter))
return this;
return null;
}
public string Format(string format, object arg, IFormatProvider provider)
{
if (arg is Int32)
{
string custNumber = ((int) arg).ToString("D10");
return custNumber.Substring(0, 4) + "-" + custNumber.Substring(4, 3) +
"-" + custNumber.Substring(7, 3);
}
else
{
return null;
}
}
}
public class Example
{
public static void Main()
{
Customer customer = new Customer("A Plus Software", 903654);
StringBuilder sb = new StringBuilder();
sb.AppendFormat(new CustomerNumberFormatter(), "{0}: {1}",
customer.CustomerNumber, customer.Name);
Console.WriteLine(sb.ToString());
}
}
// The example displays the following output:
// 0000-903-654: A Plus Software
open System
open System.Text
type Customer(name: string, number: int) =
member _.Name = name
member _.CustomerNumber = number
type CustomerNumberFormatter() =
interface IFormatProvider with
member this.GetFormat(formatType) =
if formatType = typeof<ICustomFormatter> then this else null
interface ICustomFormatter with
member _.Format(_, arg, _) =
match arg with
| :? int as i ->
let custNumber = i.ToString "D10"
$"{custNumber.Substring(0, 4)}-{custNumber.Substring(4, 3)}-{custNumber.Substring(7, 3)}"
| _ -> null
let customer = Customer("A Plus Software", 903654)
let sb = StringBuilder()
sb.AppendFormat(CustomerNumberFormatter(), "{0}: {1}", customer.CustomerNumber, customer.Name)
|> ignore
printfn $"{sb}"
// The example displays the following output:
// 0000-903-654: A Plus Software
Imports System.Text
Public Class Customer
Private custName As String
Private custNumber As Integer
Public Sub New(name As String, number As Integer)
custName = name
custNumber = number
End Sub
Public ReadOnly Property Name As String
Get
Return Me.custName
End Get
End Property
Public ReadOnly Property CustomerNumber As Integer
Get
Return Me.custNumber
End Get
End Property
End Class
Public Class CustomerNumberFormatter
Implements IFormatProvider, ICustomFormatter
Public Function GetFormat(formatType As Type) As Object _
Implements IFormatProvider.GetFormat
If formatType Is GetType(ICustomFormatter) Then
Return Me
End If
Return Nothing
End Function
Public Function Format(fmt As String, arg As Object, provider As IFormatProvider) As String _
Implements ICustomFormatter.Format
If typeof arg Is Int32 Then
Dim custNumber As String = CInt(arg).ToString("D10")
Return custNumber.Substring(0, 4) + "-" + custNumber.SubString(4, 3) + _
"-" + custNumber.Substring(7, 3)
Else
Return Nothing
End If
End Function
End Class
Module Example
Public Sub Main()
Dim customer As New Customer("A Plus Software", 903654)
Dim sb As New StringBuilder()
sb.AppendFormat(New CustomerNumberFormatter, "{0}: {1}", _
customer.CustomerNumber, customer.Name)
Console.WriteLine(sb.ToString())
End Sub
End Module
' The example displays the following output:
' 0000-903-654: A Plus Software
Observações
Este método utiliza a funcionalidade de formatação composite do .NET Framework para converter o valor de um objeto para a sua representação em texto e incorporar essa representação no objeto atual StringBuilder.
O format parâmetro consiste em zero ou mais sequências de texto misturadas com zero ou mais marcadores indexados, chamados itens de formato, que correspondem a objetos na lista de parâmetros deste método. O processo de formatação substitui cada item de formato pela representação em cadeia do objeto correspondente.
A sintaxe de um item de formato é a seguinte:
{index[,length][:formatString]}
Os elementos entre parênteses retos são opcionais. A tabela a seguir descreve cada elemento.
| Elemento | Description |
|---|---|
| índice | A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado pelo índice for null, o item de formato é substituído por String.Empty. Se não houver parâmetro na posição do índice , a FormatException é lançado. |
| ,comprimento | O número mínimo de caracteres na representação string do parâmetro. Se for positivo, o parâmetro está alinhado à direita; se for negativo, está alinhado à esquerda. |
| :formatString | Uma string de formato padrão ou personalizado suportada pelo parâmetro. |
Note
Para as cadeias de formatos padrão e personalizadas usadas com valores de data e hora, veja Cadeias de Formato de Data e Hora Padrão e Cadeias de Formato de Data e Hora Personalizadas. Para as cadeias de formatos padrão e personalizadas usadas com valores numéricos, veja Cadeias de Formato Numérico Padrão e Cadeias de Formato Numérico Personalizado. Para as cadeias de formato padrão usadas com enumerações, veja Strings de Formato de Enumeração.
O provider parâmetro especifica uma IFormatProvider implementação que pode fornecer informação de formatação para os objetos em args.
provider pode ser qualquer um dos seguintes:
Um objeto que fornece informação de formatação específica para CultureInfo cada cultura.
Um NumberFormatInfo objeto que fornece informação de formatação específica de cultura para valores numéricos em
args.Um DateTimeFormatInfo objeto que fornece informação de formatação específica da cultura para valores de data e hora em
args.Uma implementação personalizada IFormatProvider que fornece informação de formatação para um ou mais objetos em
args. Normalmente, tal implementação também implementa a ICustomFormatter interface. O segundo exemplo na secção seguinte ilustra uma StringBuilder.AppendFormat(IFormatProvider, String, Object[]) chamada de método com uma implementação personalizada IFormatProvider .
Se o provider parâmetro for null, a informação do fornecedor de formato é obtida a partir da cultura atual.
args representa os objetos a formatar. Cada item de formato em format é substituído pela representação em cadeia do objeto correspondente em args. Se o item de formato incluir formatString e o objeto correspondente em args implementar a IFormattable interface, então args[index].ToString(formatString, provider) define a formatação. Caso contrário, args[index].ToString() define a formatação.
Notas para Chamadores
No .NET Core e no .NET Framework 4.0 e versões posteriores, quando se instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento como a capacidade da instância StringBuilder podem crescer para além do valor da sua propriedade MaxCapacity. Isto pode acontecer especialmente quando chamas os Append(String) métodos e AppendFormat(String, Object) para acrescentar pequenas cadeias.
Ver também
- Tipos de Formatação em .NET
- Formatação composta
- Como: Definir e Utilizar Fornecedores de Formatos Numéricos Personalizados
- Standard Numeric Format Strings (Cadeias de Formato Numérico Padrão)
- Cadeias de caracteres de formato numérico personalizado
- Cadeias de Formatos de Data e Hora Padrão
- Cadeias de Formato de Data e Hora Personalizadas
- Cadeias de caracteres de formato TimeSpan padrão
- Cadeias de caracteres de formato TimeSpan personalizadas
- Cadeias de caracteres de formato de enumeração