StringBuilder.AppendFormat Método

Definição

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um argumento de objeto correspondente.

Sobrecargas

AppendFormat(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos argumentos usando um provedor de formato especificado.

AppendFormat(String, Object, Object, Object)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos três argumentos.

AppendFormat(IFormatProvider, String, Object, Object)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos dois argumentos usando um provedor de formato especificado.

AppendFormat(String, Object, Object)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um dos dois argumentos.

AppendFormat(IFormatProvider, String, Object, Object, Object)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos três argumentos usando um provedor de formato especificado.

AppendFormat(IFormatProvider, CompositeFormat, Object[])

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos argumentos usando um provedor de formato especificado.

AppendFormat(String, ReadOnlySpan<Object>)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um argumento correspondente em um intervalo de parâmetros.

AppendFormat(IFormatProvider, String, Object[])

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um argumento correspondente em uma matriz de parâmetros usando um provedor de formato especificado.

AppendFormat(IFormatProvider, String, Object)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um único argumento usando um provedor de formato especificado.

AppendFormat(String, Object[])

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um argumento correspondente em uma matriz de parâmetros.

AppendFormat(String, Object)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um único argumento.

AppendFormat(IFormatProvider, String, ReadOnlySpan<Object>)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um argumento correspondente em um intervalo de parâmetros usando um provedor de formato especificado.

AppendFormat<TArg0,TArg1,TArg2>(IFormatProvider, CompositeFormat, TArg0, TArg1, TArg2)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos argumentos usando um provedor de formato especificado.

AppendFormat<TArg0,TArg1>(IFormatProvider, CompositeFormat, TArg0, TArg1)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos argumentos usando um provedor de formato especificado.

AppendFormat<TArg0>(IFormatProvider, CompositeFormat, TArg0)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos argumentos usando um provedor de formato especificado.

AppendFormat(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)

Origem:
StringBuilder.cs
Origem:
StringBuilder.cs

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos argumentos usando um provedor de formato especificado.

public:
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::Text::CompositeFormat ^ format, ReadOnlySpan<System::Object ^> args);
public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, System.Text.CompositeFormat format, ReadOnlySpan<object?> args);
public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, System.Text.CompositeFormat format, scoped ReadOnlySpan<object?> args);
member this.AppendFormat : IFormatProvider * System.Text.CompositeFormat * ReadOnlySpan<obj> -> System.Text.StringBuilder
Public Function AppendFormat (provider As IFormatProvider, format As CompositeFormat, args As ReadOnlySpan(Of Object)) As StringBuilder

Parâmetros

provider
IFormatProvider

Um objeto que fornece informações de formatação específicas da cultura.

args
ReadOnlySpan<Object>

Um intervalo de objetos a serem formatados.

Retornos

Uma referência a essa instância após a conclusão da operação de acréscimo.

Exceções

format é null.

O índice de um item de formato é maior ou igual ao número de argumentos fornecidos.

Aplica-se a

AppendFormat(String, Object, Object, Object)

Origem:
StringBuilder.cs
Origem:
StringBuilder.cs
Origem:
StringBuilder.cs

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer 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);
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 caracteres de formato composto.

arg0
Object

O primeiro objeto a ser formatado.

arg1
Object

O segundo objeto a ser formatado.

arg2
Object

O terceiro objeto a ser formatado.

Retornos

Uma referência a essa instância com format acrescentado. Cada item de formato em format é substituído pela representação de cadeia de caracteres do argumento de objeto correspondente.

Exceções

format é null.

format é inválido.

-ou-

O índice de um item de formato é menor que 0 (zero) ou maior ou igual a 3.

O comprimento da cadeia de caracteres expandida excederia MaxCapacity.

Exemplos

O exemplo a seguir demonstra o método AppendFormat.

using namespace System;
using namespace System::Text;
using namespace System::Globalization;
void Show( StringBuilder^ sbs )
{
   Console::WriteLine( sbs );
   sbs->Length = 0;
}

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'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 = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   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
*/
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

Comentários

Esse método usa o recurso de formatação composta do .NET Framework para converter o valor de um objeto em sua representação de texto e inserir essa representação no objeto StringBuilder atual.

O parâmetro format consiste em zero ou mais execuções de texto intermixado com zero ou mais espaços reservados indexados, chamados itens de formato, que correspondem a arg0 por arg2, os objetos na lista de parâmetros desse método. O processo de formatação substitui cada item de formato pela representação de cadeia de caracteres do objeto correspondente.

A sintaxe de um item de formato é a seguinte:

{de índice [,comprimento][:formatString]}

Elementos em colchetes são opcionais. A tabela a seguir descreve cada elemento.

Elemento Descrição
de índice A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado por índice for null, o item de formato será substituído por String.Empty. Se não houver nenhum parâmetro na posição de índice , um será gerado.
,comprimento O número mínimo de caracteres na representação de cadeia de caracteres do parâmetro. Se positivo, o parâmetro está alinhado à direita; se negativo, ele é alinhado à esquerda.
:formatString Uma cadeia de caracteres de formato padrão ou personalizado compatível com o parâmetro.

Nota

Para as cadeias de caracteres de formato padrão e personalizado usadas com valores de data e hora, consulte cadeias de caracteres de formato de data e hora padrão e cadeias de caracteres de formato de data e hora personalizadas. Para as cadeias de caracteres de formato padrão e personalizado usadas com valores numéricos, consulte Cadeias de Caracteres de Formato Numérico Padrão e Cadeias de Caracteres de Formato Numérico Personalizado. Para as cadeias de caracteres de formato padrão usadas com enumerações, consulte cadeias de caracteres de formato de enumeração.

arg0, arg1e arg2 representam os objetos a serem formatados. Cada item de formato em format é substituído pela representação de cadeia de caracteres de arg0, arg1ou arg2, dependendo do índice do item de formato. Se o item de formato incluir formatString e o objeto correspondente no args implementar a interface IFormattable, argx.ToString(formatString, null) definirá a formatação, em que x é o índice do argumento. Caso contrário, argx.ToString() definirá a formatação.

Se a cadeia de caracteres atribuída à format for "Obrigado pela doação de {0:####} latas de alimentos para nossa organização de caridade." e arg0 for um inteiro com o valor 10, o valor retornado será "Obrigado pela doação de 10 latas de alimentos para nossa organização de caridade".

Notas aos Chamadores

No .NET Core e no .NET Framework 4.0 e versões posteriores, quando você instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento quanto a capacidade da instância de StringBuilder podem crescer além do valor de sua propriedade MaxCapacity. Isso pode ocorrer especialmente quando você chama os métodos Append(String) e AppendFormat(String, Object) para acrescentar cadeias de caracteres pequenas.

Confira também

Aplica-se a

AppendFormat(IFormatProvider, String, Object, Object)

Origem:
StringBuilder.cs
Origem:
StringBuilder.cs
Origem:
StringBuilder.cs

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos dois argumentos usando um provedor 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);
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ções de formatação específicas da cultura.

format
String

Uma cadeia de caracteres de formato composto.

arg0
Object

O primeiro objeto a ser formatado.

arg1
Object

O segundo objeto a ser formatado.

Retornos

Uma referência a essa instância após a conclusão da operação de acréscimo. Após a operação de acréscimo, essa instância contém todos os dados que existiam antes da operação, sufixos por uma cópia de format em que qualquer especificação de formato é substituída pela representação de cadeia de caracteres do argumento de objeto correspondente.

Exceções

format é null.

format é inválido.

-ou-

O índice de um item de formato é menor que 0 (zero) ou maior ou igual a 2 (dois).

O comprimento da cadeia de caracteres expandida excederia MaxCapacity.

Exemplos

O exemplo a seguir usa o método AppendFormat(IFormatProvider, String, Object, Object) para exibir dados de tempo e temperatura armazenados em um objeto Dictionary<TKey,TValue> genérico. Observe que a cadeia de caracteres de formato tem três itens de formato, embora haja apenas objetos para formatar. Isso ocorre porque o primeiro objeto na lista (um valor de data e hora) é usado por dois itens de formato: o primeiro item de formato exibe a hora e o segundo exibe 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

Comentários

Esse método usa o recurso de formatação composta do .NET Framework para converter o valor de um objeto em sua representação de texto e inserir essa representação no objeto StringBuilder atual.

O parâmetro format consiste em zero ou mais execuções de texto intermixado com zero ou mais espaços reservados indexados, chamados de itens de formato, que correspondem a objetos na lista de parâmetros desse método. O processo de formatação substitui cada item de formato pela representação de cadeia de caracteres do objeto correspondente.

A sintaxe de um item de formato é a seguinte:

{de índice [,comprimento][:formatString]}

Elementos em colchetes são opcionais. A tabela a seguir descreve cada elemento.

Elemento Descrição
de índice A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado por índice for null, o item de formato será substituído por String.Empty. Se não houver nenhum parâmetro na posição de índice , um será gerado.
,comprimento O número mínimo de caracteres na representação de cadeia de caracteres do parâmetro. Se positivo, o parâmetro está alinhado à direita; se negativo, ele é alinhado à esquerda.
:formatString Uma cadeia de caracteres de formato padrão ou personalizado compatível com o parâmetro.

Nota

Para as cadeias de caracteres de formato padrão e personalizado usadas com valores de data e hora, consulte cadeias de caracteres de formato de data e hora padrão e cadeias de caracteres de formato de data e hora personalizadas. Para as cadeias de caracteres de formato padrão e personalizado usadas com valores numéricos, consulte Cadeias de Caracteres de Formato Numérico Padrão e Cadeias de Caracteres de Formato Numérico Personalizado. Para as cadeias de caracteres de formato padrão usadas com enumerações, consulte cadeias de caracteres de formato de enumeração.

O parâmetro provider especifica uma implementação de IFormatProvider que pode fornecer informações de formatação para arg0 e arg1. provider pode ser qualquer um dos seguintes:

  • Um objeto CultureInfo que fornece informações de formatação específicas da cultura.

  • Um objeto NumberFormatInfo que fornece informações de formatação específicas à cultura para arg0 ou arg1 se forem valores numéricos.

  • Um objeto DateTimeFormatInfo que fornece informações de formatação específicas à cultura para arg0 ou arg1 se forem valores de data e hora.

  • Uma implementação de IFormatProvider personalizada que fornece informações de formatação para arg0 e arg1. Normalmente, essa implementação também implementa a interface ICustomFormatter.

Se o parâmetro provider for null, as informações do provedor de formato serão obtidas da cultura atual.

arg0 e arg1 representam os objetos a serem formatados. Cada item de formato em format é substituído pela representação de cadeia de caracteres do objeto que tem o índice correspondente. Se o item de formato incluir formatString e o argumento correspondente implementar a interface IFormattable, o método ToString(formatString, provider) do argumento definirá a formatação. Caso contrário, o método ToString() do argumento define a formatação.

Notas aos Chamadores

No .NET Core e no .NET Framework 4.0 e versões posteriores, quando você instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento quanto a capacidade da instância de StringBuilder podem crescer além do valor de sua propriedade MaxCapacity. Isso pode ocorrer especialmente quando você chama os métodos Append(String) e AppendFormat(String, Object) para acrescentar cadeias de caracteres pequenas.

Confira também

Aplica-se a

AppendFormat(String, Object, Object)

Origem:
StringBuilder.cs
Origem:
StringBuilder.cs
Origem:
StringBuilder.cs

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um dos 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);
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 caracteres de formato composto.

arg0
Object

O primeiro objeto a ser formatado.

arg1
Object

O segundo objeto a ser formatado.

Retornos

Uma referência a essa instância com format acrescentado. Cada item de formato em format é substituído pela representação de cadeia de caracteres do argumento de objeto correspondente.

Exceções

format é null.

format é inválido.

-ou-

O índice de um item de formato é menor que 0 (zero) ou maior ou igual a 2.

O comprimento da cadeia de caracteres expandida excederia MaxCapacity.

Exemplos

O exemplo a seguir demonstra o método AppendFormat.

using namespace System;
using namespace System::Text;
using namespace System::Globalization;
void Show( StringBuilder^ sbs )
{
   Console::WriteLine( sbs );
   sbs->Length = 0;
}

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'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 = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   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
*/
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

Comentários

Esse método usa o recurso de formatação composta do .NET Framework para converter o valor de um objeto em sua representação de texto e inserir essa representação no objeto StringBuilder atual.

O parâmetro format consiste em zero ou mais execuções de texto intermixado com zero ou mais espaços reservados indexados, chamados itens de formato, que correspondem a arg0 e arg1, os dois objetos na lista de parâmetros desse método. O processo de formatação substitui cada item de formato pela representação de cadeia de caracteres do objeto correspondente.

A sintaxe de um item de formato é a seguinte:

{de índice [,comprimento][:formatString]}

Elementos em colchetes são opcionais. A tabela a seguir descreve cada elemento.

Elemento Descrição
de índice A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado por índice for null, o item de formato será substituído por String.Empty. Se não houver nenhum parâmetro na posição de índice , um será gerado.
,comprimento O número mínimo de caracteres na representação de cadeia de caracteres do parâmetro. Se positivo, o parâmetro está alinhado à direita; se negativo, ele é alinhado à esquerda.
:formatString Uma cadeia de caracteres de formato padrão ou personalizado compatível com o parâmetro.

Nota

Para as cadeias de caracteres de formato padrão e personalizado usadas com valores de data e hora, consulte cadeias de caracteres de formato de data e hora padrão e cadeias de caracteres de formato de data e hora personalizadas. Para as cadeias de caracteres de formato padrão e personalizado usadas com valores numéricos, consulte Cadeias de Caracteres de Formato Numérico Padrão e Cadeias de Caracteres de Formato Numérico Personalizado. Para as cadeias de caracteres de formato padrão usadas com enumerações, consulte cadeias de caracteres 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 de cadeia de caracteres de arg0 ou arg1. Se o item de formato incluir formatString e o objeto correspondente implementar a interface IFormattable, argx.ToString(formatString, provider) definirá a formatação, em que x é o índice do argumento. Caso contrário, argx.ToString() definirá a formatação.

Se a cadeia de caracteres atribuída à format for "Obrigado pela doação de {0:####} latas de alimentos para nossa organização de caridade." e arg0 for um inteiro com o valor 10, o valor retornado será "Obrigado pela doação de 10 latas de alimentos para nossa organização de caridade".

Notas aos Chamadores

No .NET Core e no .NET Framework 4.0 e versões posteriores, quando você instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento quanto a capacidade da instância de StringBuilder podem crescer além do valor de sua propriedade MaxCapacity. Isso pode ocorrer especialmente quando você chama os métodos Append(String) e AppendFormat(String, Object) para acrescentar cadeias de caracteres pequenas.

Confira também

Aplica-se a

AppendFormat(IFormatProvider, String, Object, Object, Object)

Origem:
StringBuilder.cs
Origem:
StringBuilder.cs
Origem:
StringBuilder.cs

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos três argumentos usando um provedor 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);
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ções de formatação específicas da cultura.

format
String

Uma cadeia de caracteres de formato composto.

arg0
Object

O primeiro objeto a ser formatado.

arg1
Object

O segundo objeto a ser formatado.

arg2
Object

O terceiro objeto a ser formatado.

Retornos

Uma referência a essa instância após a conclusão da operação de acréscimo. Após a operação de acréscimo, essa instância contém todos os dados que existiam antes da operação, sufixos por uma cópia de format em que qualquer especificação de formato é substituída pela representação de cadeia de caracteres do argumento de objeto correspondente.

Exceções

format é null.

format é inválido.

-ou-

O índice de um item de formato é menor que 0 (zero) ou maior ou igual a 3 (três).

O comprimento da cadeia de caracteres expandida excederia MaxCapacity.

Exemplos

O exemplo a seguir usa o método AppendFormat(IFormatProvider, String, Object, Object, Object) para ilustrar o resultado de uma operação de And booliana com valores inteiros. Observe que a cadeia de caracteres de formato inclui seis itens de formato, mas o método tem apenas três itens em sua lista de argumentos, porque cada item é formatado de duas maneiras 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)

Comentários

Esse método usa o recurso de formatação composta do .NET Framework para converter o valor de um objeto em sua representação de texto e inserir essa representação no objeto StringBuilder atual.

O parâmetro format consiste em zero ou mais execuções de texto intermixado com zero ou mais espaços reservados indexados, chamados de itens de formato, que correspondem a objetos na lista de parâmetros desse método. O processo de formatação substitui cada item de formato pela representação de cadeia de caracteres do objeto correspondente.

A sintaxe de um item de formato é a seguinte:

{de índice [,comprimento][:formatString]}

Elementos em colchetes são opcionais. A tabela a seguir descreve cada elemento.

Elemento Descrição
de índice A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado por índice for null, o item de formato será substituído por String.Empty. Se não houver nenhum parâmetro na posição de índice , um será gerado.
,comprimento O número mínimo de caracteres na representação de cadeia de caracteres do parâmetro. Se positivo, o parâmetro está alinhado à direita; se negativo, ele é alinhado à esquerda.
:formatString Uma cadeia de caracteres de formato padrão ou personalizado compatível com o parâmetro.

Nota

Para as cadeias de caracteres de formato padrão e personalizado usadas com valores de data e hora, consulte cadeias de caracteres de formato de data e hora padrão e cadeias de caracteres de formato de data e hora personalizadas. Para as cadeias de caracteres de formato padrão e personalizado usadas com valores numéricos, consulte Cadeias de Caracteres de Formato Numérico Padrão e Cadeias de Caracteres de Formato Numérico Personalizado. Para as cadeias de caracteres de formato padrão usadas com enumerações, consulte cadeias de caracteres de formato de enumeração.

O parâmetro provider especifica uma implementação de IFormatProvider que pode fornecer informações de formatação para arg0 e arg1. provider pode ser qualquer um dos seguintes:

  • Um objeto CultureInfo que fornece informações de formatação específicas da cultura.

  • Um objeto NumberFormatInfo que fornece informações de formatação específicas à cultura para arg0 ou arg1 se forem valores numéricos.

  • Um objeto DateTimeFormatInfo que fornece informações de formatação específicas à cultura para arg0, arg1ou arg2 se forem valores de data e hora.

  • Uma implementação de IFormatProvider personalizada que fornece informações de formatação para arg0, arg1e arg2. Normalmente, essa implementação também implementa a interface ICustomFormatter.

Se o parâmetro provider for null, as informações do provedor de formato serão obtidas da cultura atual.

arg0, arg1e arg2 representam os objetos a serem formatados. Cada item de formato em format é substituído pela representação de cadeia de caracteres do objeto que tem o índice correspondente. Se o item de formato incluir formatString e o argumento correspondente implementar a interface IFormattable, o método ToString(formatString, provider) do argumento definirá a formatação. Caso contrário, o método ToString() do argumento define a formatação.

Notas aos Chamadores

No .NET Core e no .NET Framework 4.0 e versões posteriores, quando você instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento quanto a capacidade da instância de StringBuilder podem crescer além do valor de sua propriedade MaxCapacity. Isso pode ocorrer especialmente quando você chama os métodos Append(String) e AppendFormat(String, Object) para acrescentar cadeias de caracteres pequenas.

Confira também

Aplica-se a

AppendFormat(IFormatProvider, CompositeFormat, Object[])

Origem:
StringBuilder.cs
Origem:
StringBuilder.cs

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos argumentos usando um provedor de formato especificado.

public:
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::Text::CompositeFormat ^ format, ... cli::array <System::Object ^> ^ args);
public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, System.Text.CompositeFormat format, params object?[] args);
member this.AppendFormat : IFormatProvider * System.Text.CompositeFormat * obj[] -> System.Text.StringBuilder
Public Function AppendFormat (provider As IFormatProvider, format As CompositeFormat, ParamArray args As Object()) As StringBuilder

Parâmetros

provider
IFormatProvider

Um objeto que fornece informações de formatação específicas da cultura.

args
Object[]

Uma matriz de objetos a serem formatados.

Retornos

Uma referência a essa instância após a conclusão da operação de acréscimo.

Exceções

format ou args é null.

O índice de um item de formato é maior ou igual ao número de argumentos fornecidos.

Aplica-se a

AppendFormat(String, ReadOnlySpan<Object>)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um argumento correspondente em um intervalo de parâmetros.

public:
 System::Text::StringBuilder ^ AppendFormat(System::String ^ format, ReadOnlySpan<System::Object ^> args);
public System.Text.StringBuilder AppendFormat (string format, scoped ReadOnlySpan<object?> args);
member this.AppendFormat : string * ReadOnlySpan<obj> -> System.Text.StringBuilder
Public Function AppendFormat (format As String, args As ReadOnlySpan(Of Object)) As StringBuilder

Parâmetros

format
String

Uma cadeia de caracteres de formato composto.

args
ReadOnlySpan<Object>

Um intervalo de objetos a serem formatados.

Retornos

Uma referência a essa instância após a conclusão da operação de acréscimo.

Exceções

format é null.

O comprimento da cadeia de caracteres expandida excederia MaxCapacity.

format é inválido.

-ou-

O índice de um item de formato é menor que 0 (zero) ou maior ou igual ao comprimento do intervalo de args.

Aplica-se a

AppendFormat(IFormatProvider, String, Object[])

Origem:
StringBuilder.cs
Origem:
StringBuilder.cs
Origem:
StringBuilder.cs

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um argumento correspondente em uma matriz de parâmetros usando um provedor 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);
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ções de formatação específicas da cultura.

format
String

Uma cadeia de caracteres de formato composto.

args
Object[]

Uma matriz de objetos a serem formatados.

Retornos

Uma referência a essa instância após a conclusão da operação de acréscimo. Após a operação de acréscimo, essa instância contém todos os dados que existiam antes da operação, sufixos por uma cópia de format em que qualquer especificação de formato é substituída pela representação de cadeia de caracteres do argumento de objeto correspondente.

Exceções

format é null.

format é inválido.

-ou-

O índice de um item de formato é menor que 0 (zero) ou maior ou igual ao comprimento da matriz args.

O comprimento da cadeia de caracteres expandida excederia MaxCapacity.

Exemplos

O exemplo a seguir demonstra o método AppendFormat.

using namespace System;
using namespace System::Text;
using namespace System::Globalization;
void Show( StringBuilder^ sbs )
{
   Console::WriteLine( sbs );
   sbs->Length = 0;
}

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'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 = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   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
*/
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 a seguir define uma implementação de IFormatProvider personalizada chamada CustomerFormatter que formata um número de cliente de 10 dígitos com hifens após o quarto e o sétimo dígitos. Ele é passado para o método StringBuilder.AppendFormat(IFormatProvider, String, Object[]) para criar uma cadeia de caracteres 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

Comentários

Esse método usa o recurso de formatação composta do .NET Framework para converter o valor de um objeto em sua representação de texto e inserir essa representação no objeto StringBuilder atual.

O parâmetro format consiste em zero ou mais execuções de texto intermixado com zero ou mais espaços reservados indexados, chamados de itens de formato, que correspondem a objetos na lista de parâmetros desse método. O processo de formatação substitui cada item de formato pela representação de cadeia de caracteres do objeto correspondente.

A sintaxe de um item de formato é a seguinte:

{de índice [,comprimento][:formatString]}

Elementos em colchetes são opcionais. A tabela a seguir descreve cada elemento.

Elemento Descrição
de índice A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado por índice for null, o item de formato será substituído por String.Empty. Se não houver nenhum parâmetro na posição de índice , um será gerado.
,comprimento O número mínimo de caracteres na representação de cadeia de caracteres do parâmetro. Se positivo, o parâmetro está alinhado à direita; se negativo, ele é alinhado à esquerda.
:formatString Uma cadeia de caracteres de formato padrão ou personalizado compatível com o parâmetro.

Nota

Para as cadeias de caracteres de formato padrão e personalizado usadas com valores de data e hora, consulte cadeias de caracteres de formato de data e hora padrão e cadeias de caracteres de formato de data e hora personalizadas. Para as cadeias de caracteres de formato padrão e personalizado usadas com valores numéricos, consulte Cadeias de Caracteres de Formato Numérico Padrão e Cadeias de Caracteres de Formato Numérico Personalizado. Para as cadeias de caracteres de formato padrão usadas com enumerações, consulte cadeias de caracteres de formato de enumeração.

O parâmetro provider especifica uma implementação de IFormatProvider que pode fornecer informações de formatação para os objetos em args. provider pode ser qualquer um dos seguintes:

Se o parâmetro provider for null, as informações do provedor de formato serão obtidas da cultura atual.

args representa os objetos a serem formatados. Cada item de formato em format é substituído pela representação de cadeia de caracteres do objeto correspondente em args. Se o item de formato incluir formatString e o objeto correspondente em args implementar a interface IFormattable, args[index].ToString(formatString, provider) definirá a formatação. Caso contrário, args[index].ToString() definirá a formatação.

Notas aos Chamadores

No .NET Core e no .NET Framework 4.0 e versões posteriores, quando você instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento quanto a capacidade da instância de StringBuilder podem crescer além do valor de sua propriedade MaxCapacity. Isso pode ocorrer especialmente quando você chama os métodos Append(String) e AppendFormat(String, Object) para acrescentar cadeias de caracteres pequenas.

Confira também

Aplica-se a

AppendFormat(IFormatProvider, String, Object)

Origem:
StringBuilder.cs
Origem:
StringBuilder.cs
Origem:
StringBuilder.cs

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um único argumento usando um provedor 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);
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ções de formatação específicas da cultura.

format
String

Uma cadeia de caracteres de formato composto.

arg0
Object

O objeto a ser formatado.

Retornos

Uma referência a essa instância após a conclusão da operação de acréscimo. Após a operação de acréscimo, essa instância contém todos os dados que existiam antes da operação, sufixos por uma cópia de format em que qualquer especificação de formato é substituída pela representação de cadeia de caracteres 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 um (1).

O comprimento da cadeia de caracteres expandida excederia MaxCapacity.

Exemplos

O seguinte inclui duas chamadas para o método AppendFormat(IFormatProvider, String, Object). Ambos usam as convenções de formatação da cultura English-United Kingdom (en-GB). O primeiro insere a representação de cadeia de caracteres de uma moeda de valor Decimal em uma cadeia de caracteres de resultado. O segundo insere um valor DateTime em dois lugares em uma cadeia de caracteres de resultado, a primeira incluindo apenas a cadeia de caracteres de data curta e a segunda a cadeia de caracteres 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

Comentários

Esse método usa o recurso de formatação composta do .NET Framework para converter o valor de arg0 em sua representação de texto e inserir essa representação no objeto StringBuilder atual.

O parâmetro format consiste em zero ou mais execuções de texto intermixado com zero ou mais espaços reservados indexados, chamados de itens de formato. O índice de cada item de formato deve ser zero (0), pois esse método inclui uma lista de argumentos com um único argumento. O processo de formatação substitui cada item de formato pela representação de cadeia de caracteres de arg0.

A sintaxe de um item de formato é a seguinte:

{de índice [,comprimento][:formatString]}

Elementos em colchetes são opcionais. A tabela a seguir descreve cada elemento.

Elemento Descrição
de índice A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado por índice for null, o item de formato será substituído por String.Empty. Nesse caso, como o método AppendFormat(IFormatProvider, String, Object) tem um único argumento na lista de argumentos, o valor de índice deve ser sempre 0. Se não for, uma FormatException será lançada.
,comprimento O número mínimo de caracteres na representação de cadeia de caracteres do parâmetro. Se positivo, o parâmetro está alinhado à direita; se negativo, ele é alinhado à esquerda.
:formatString Uma cadeia de caracteres de formato padrão ou personalizado compatível com o parâmetro.

Nota

Para as cadeias de caracteres de formato padrão e personalizado usadas com valores de data e hora, consulte cadeias de caracteres de formato de data e hora padrão e cadeias de caracteres de formato de data e hora personalizadas. Para as cadeias de caracteres de formato padrão e personalizado usadas com valores numéricos, consulte Cadeias de Caracteres de Formato Numérico Padrão e Cadeias de Caracteres de Formato Numérico Personalizado. Para as cadeias de caracteres de formato padrão usadas com enumerações, consulte cadeias de caracteres de formato de enumeração.

O parâmetro provider especifica uma implementação de IFormatProvider que pode fornecer informações de formatação para os objetos em args. provider pode ser qualquer um dos seguintes:

  • Um objeto CultureInfo que fornece informações de formatação específicas da cultura.

  • Um objeto NumberFormatInfo que fornece informações de formatação específicas da cultura para arg0 se for um valor numérico.

  • Um objeto DateTimeFormatInfo que fornece informações de formatação específicas da cultura para arg0 se for um valor de data e hora.

  • Uma implementação de IFormatProvider personalizada que fornece informações de formatação para arg0. Normalmente, essa implementação também implementa a interface ICustomFormatter.

Se o parâmetro provider for null, as informações de formatação serão obtidas da cultura atual.

arg0 representa o objeto a ser formatado. Cada item de formato em format é substituído pela representação de cadeia de caracteres de arg0. Se o item de formato incluir formatString e arg0 implementar a interface IFormattable, arg0.ToString(formatString, provider) definirá a formatação. Caso contrário, arg0.ToString() definirá a formatação.

Notas aos Chamadores

No .NET Core e no .NET Framework 4.0 e versões posteriores, quando você instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento quanto a capacidade da instância de StringBuilder podem crescer além do valor de sua propriedade MaxCapacity. Isso pode ocorrer especialmente quando você chama os métodos Append(String) e AppendFormat(String, Object) para acrescentar cadeias de caracteres pequenas.

Confira também

Aplica-se a

AppendFormat(String, Object[])

Origem:
StringBuilder.cs
Origem:
StringBuilder.cs
Origem:
StringBuilder.cs

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um argumento correspondente em uma matriz 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);
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 caracteres de formato composto.

args
Object[]

Uma matriz de objetos a serem formatados.

Retornos

Uma referência a essa instância com format acrescentado. Cada item de formato em format é substituído pela representação de cadeia de caracteres do argumento de objeto correspondente.

Exceções

format ou args é null.

format é inválido.

-ou-

O índice de um item de formato é menor que 0 (zero) ou maior ou igual ao comprimento da matriz args.

O comprimento da cadeia de caracteres expandida excederia MaxCapacity.

Exemplos

O exemplo a seguir demonstra o método AppendFormat.

using namespace System;
using namespace System::Text;
using namespace System::Globalization;
void Show( StringBuilder^ sbs )
{
   Console::WriteLine( sbs );
   sbs->Length = 0;
}

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'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 = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   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
*/
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

Comentários

Esse método usa o recurso de formatação composta do .NET Framework para converter o valor de um objeto em sua representação de texto e inserir essa representação no objeto StringBuilder atual.

O parâmetro format consiste em zero ou mais execuções de texto intermixado com zero ou mais espaços reservados indexados, chamados de itens de formato, que correspondem a objetos na lista de parâmetros desse método. O processo de formatação substitui cada item de formato pela representação de cadeia de caracteres do objeto correspondente.

A sintaxe de um item de formato é a seguinte:

{de índice [,comprimento][:formatString]}

Elementos em colchetes são opcionais. A tabela a seguir descreve cada elemento.

Elemento Descrição
de índice A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado por índice for null, o item de formato será substituído por String.Empty. Se não houver nenhum parâmetro na posição de índice , um será gerado.
,comprimento O número mínimo de caracteres na representação de cadeia de caracteres do parâmetro. Se positivo, o parâmetro está alinhado à direita; se negativo, ele é alinhado à esquerda.
:formatString Uma cadeia de caracteres de formato padrão ou personalizado compatível com o parâmetro.

Nota

Para as cadeias de caracteres de formato padrão e personalizado usadas com valores de data e hora, consulte cadeias de caracteres de formato de data e hora padrão e cadeias de caracteres de formato de data e hora personalizadas. Para as cadeias de caracteres de formato padrão e personalizado usadas com valores numéricos, consulte Cadeias de Caracteres de Formato Numérico Padrão e Cadeias de Caracteres de Formato Numérico Personalizado. Para as cadeias de caracteres de formato padrão usadas com enumerações, consulte cadeias de caracteres de formato de enumeração.

args representa os objetos a serem formatados. Cada item de formato em format é substituído pela representação de cadeia de caracteres do objeto correspondente em args. Se o item de formato incluir formatString e o objeto correspondente em args implementar a interface IFormattable, args[index].ToString(formatString, provider) definirá a formatação. Caso contrário, args[index].ToString() definirá a formatação.

Se a cadeia de caracteres atribuída à format for "Obrigado pela doação de {0:####} latas de alimentos para nossa organização de caridade." e arg0 for um inteiro com o valor 10, o valor retornado será "Obrigado pela doação de 10 latas de alimentos para nossa organização de caridade".

Notas aos Chamadores

No .NET Core e no .NET Framework 4.0 e versões posteriores, quando você instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento quanto a capacidade da instância de StringBuilder podem crescer além do valor de sua propriedade MaxCapacity. Isso pode ocorrer especialmente quando você chama os métodos Append(String) e AppendFormat(String, Object) para acrescentar cadeias de caracteres pequenas.

Confira também

Aplica-se a

AppendFormat(String, Object)

Origem:
StringBuilder.cs
Origem:
StringBuilder.cs
Origem:
StringBuilder.cs

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um único argumento.

public:
 System::Text::StringBuilder ^ AppendFormat(System::String ^ format, System::Object ^ arg0);
public System.Text.StringBuilder AppendFormat (string format, 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 caracteres de formato composto.

arg0
Object

Um objeto a ser formatado.

Retornos

Uma referência a essa instância com format acrescentado. Cada item de formato em format é substituído pela representação de cadeia de caracteres 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 cadeia de caracteres expandida excederia MaxCapacity.

Exemplos

O exemplo a seguir demonstra o método AppendFormat.

using namespace System;
using namespace System::Text;
using namespace System::Globalization;
void Show( StringBuilder^ sbs )
{
   Console::WriteLine( sbs );
   sbs->Length = 0;
}

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'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 = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   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
*/
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

Comentários

Esse método usa o recurso de formatação composta do .NET Framework para converter o valor de um objeto em sua representação de texto e inserir essa representação no objeto StringBuilder atual.

O parâmetro format consiste em zero ou mais execuções de texto intermixado com zero ou mais espaços reservados indexados, chamados de itens de formato. O índice dos itens de formato deve ser 0, para corresponder a arg0, o único objeto na lista de parâmetros desse método. O processo de formatação substitui cada item de formato pela representação de cadeia de caracteres de arg0.

A sintaxe de um item de formato é a seguinte:

{de índice [,comprimento][:formatString]}

Elementos em colchetes são opcionais. A tabela a seguir descreve cada elemento.

Elemento Descrição
de índice A posição baseada em zero na lista de parâmetros do objeto a ser formatado. Se o objeto especificado por índice for null, o item de formato será substituído por String.Empty. Se não houver nenhum parâmetro na posição de índice , um será gerado.
,comprimento O número mínimo de caracteres na representação de cadeia de caracteres do parâmetro. Se positivo, o parâmetro está alinhado à direita; se negativo, ele é alinhado à esquerda.
:formatString Uma cadeia de caracteres de formato padrão ou personalizado compatível com o parâmetro.

Nota

Para as cadeias de caracteres de formato padrão e personalizado usadas com valores de data e hora, consulte cadeias de caracteres de formato de data e hora padrão e cadeias de caracteres de formato de data e hora personalizadas. Para as cadeias de caracteres de formato padrão e personalizado usadas com valores numéricos, consulte Cadeias de Caracteres de Formato Numérico Padrão e Cadeias de Caracteres de Formato Numérico Personalizado. Para as cadeias de caracteres de formato padrão usadas com enumerações, consulte cadeias de caracteres de formato de enumeração.

arg0 representa o objeto a ser formatado. Cada item de formato em format é substituído pela representação de cadeia de caracteres de arg0. Se o item de formato incluir formatString e arg0 implementar a interface IFormattable, arg0.ToString(formatString, null) definirá a formatação. Caso contrário, arg0.ToString() definirá a formatação.

Se a cadeia de caracteres atribuída à format for "Obrigado pela doação de {0:####} latas de alimentos para nossa organização de caridade." e arg0 for um inteiro com o valor 10, o valor retornado será "Obrigado pela doação de 10 latas de alimentos para nossa organização de caridade".

Notas aos Chamadores

No .NET Core e no .NET Framework 4.0 e versões posteriores, quando você instancia o objeto StringBuilder chamando o construtor StringBuilder(Int32, Int32), tanto o comprimento quanto a capacidade da instância de StringBuilder podem crescer além do valor de sua propriedade MaxCapacity. Isso pode ocorrer especialmente quando você chama os métodos Append(String) e AppendFormat(String, Object) para acrescentar cadeias de caracteres pequenas.

Confira também

Aplica-se a

AppendFormat(IFormatProvider, String, ReadOnlySpan<Object>)

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de um argumento correspondente em um intervalo de parâmetros usando um provedor de formato especificado.

public:
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::String ^ format, ReadOnlySpan<System::Object ^> args);
public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, string format, scoped ReadOnlySpan<object?> args);
member this.AppendFormat : IFormatProvider * string * ReadOnlySpan<obj> -> System.Text.StringBuilder
Public Function AppendFormat (provider As IFormatProvider, format As String, args As ReadOnlySpan(Of Object)) As StringBuilder

Parâmetros

provider
IFormatProvider

Um objeto que fornece informações de formatação específicas da cultura.

format
String

Uma cadeia de caracteres de formato composto.

args
ReadOnlySpan<Object>

Um intervalo de objetos a serem formatados.

Retornos

Uma referência a essa instância após a conclusão da operação de acréscimo.

Exceções

format é null.

O comprimento da cadeia de caracteres expandida excederia MaxCapacity.

format é inválido.

-ou-

O índice de um item de formato é menor que 0 (zero) ou maior ou igual ao comprimento do intervalo de args.

Aplica-se a

AppendFormat<TArg0,TArg1,TArg2>(IFormatProvider, CompositeFormat, TArg0, TArg1, TArg2)

Origem:
StringBuilder.cs
Origem:
StringBuilder.cs

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos argumentos usando um provedor de formato especificado.

public:
generic <typename TArg0, typename TArg1, typename TArg2>
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::Text::CompositeFormat ^ format, TArg0 arg0, TArg1 arg1, TArg2 arg2);
public System.Text.StringBuilder AppendFormat<TArg0,TArg1,TArg2> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0, TArg1 arg1, TArg2 arg2);
member this.AppendFormat : IFormatProvider * System.Text.CompositeFormat * 'TArg0 * 'TArg1 * 'TArg2 -> System.Text.StringBuilder
Public Function AppendFormat(Of TArg0, TArg1, TArg2) (provider As IFormatProvider, format As CompositeFormat, arg0 As TArg0, arg1 As TArg1, arg2 As TArg2) As StringBuilder

Parâmetros de tipo

TArg0

O tipo do primeiro objeto a ser formatado.

TArg1

O tipo do segundo objeto a ser formatado.

TArg2

O tipo do terceiro objeto a ser formatado.

Parâmetros

provider
IFormatProvider

Um objeto que fornece informações de formatação específicas da cultura.

arg0
TArg0

O primeiro objeto a ser formatado.

arg1
TArg1

O segundo objeto a ser formatado.

arg2
TArg2

O terceiro objeto a ser formatado.

Retornos

Uma referência a essa instância após a conclusão da operação de acréscimo.

Exceções

format é null.

O índice de um item de formato é maior ou igual ao número de argumentos fornecidos.

Aplica-se a

AppendFormat<TArg0,TArg1>(IFormatProvider, CompositeFormat, TArg0, TArg1)

Origem:
StringBuilder.cs
Origem:
StringBuilder.cs

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos argumentos usando um provedor de formato especificado.

public:
generic <typename TArg0, typename TArg1>
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::Text::CompositeFormat ^ format, TArg0 arg0, TArg1 arg1);
public System.Text.StringBuilder AppendFormat<TArg0,TArg1> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0, TArg1 arg1);
member this.AppendFormat : IFormatProvider * System.Text.CompositeFormat * 'TArg0 * 'TArg1 -> System.Text.StringBuilder
Public Function AppendFormat(Of TArg0, TArg1) (provider As IFormatProvider, format As CompositeFormat, arg0 As TArg0, arg1 As TArg1) As StringBuilder

Parâmetros de tipo

TArg0

O tipo do primeiro objeto a ser formatado.

TArg1

O tipo do segundo objeto a ser formatado.

Parâmetros

provider
IFormatProvider

Um objeto que fornece informações de formatação específicas da cultura.

arg0
TArg0

O primeiro objeto a ser formatado.

arg1
TArg1

O segundo objeto a ser formatado.

Retornos

Uma referência a essa instância após a conclusão da operação de acréscimo.

Exceções

format é null.

O índice de um item de formato é maior ou igual ao número de argumentos fornecidos.

Aplica-se a

AppendFormat<TArg0>(IFormatProvider, CompositeFormat, TArg0)

Origem:
StringBuilder.cs
Origem:
StringBuilder.cs

Acrescenta a cadeia de caracteres retornada processando uma cadeia de caracteres 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 cadeia de caracteres de qualquer um dos argumentos usando um provedor de formato especificado.

public:
generic <typename TArg0>
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::Text::CompositeFormat ^ format, TArg0 arg0);
public System.Text.StringBuilder AppendFormat<TArg0> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0);
member this.AppendFormat : IFormatProvider * System.Text.CompositeFormat * 'TArg0 -> System.Text.StringBuilder
Public Function AppendFormat(Of TArg0) (provider As IFormatProvider, format As CompositeFormat, arg0 As TArg0) As StringBuilder

Parâmetros de tipo

TArg0

O tipo do primeiro objeto a ser formatado.

Parâmetros

provider
IFormatProvider

Um objeto que fornece informações de formatação específicas da cultura.

arg0
TArg0

O primeiro objeto a ser formatado.

Retornos

Uma referência a essa instância após a conclusão da operação de acréscimo.

Exceções

format é null.

O índice de um item de formato é maior ou igual ao número de argumentos fornecidos.

Aplica-se a