Ler en inglés

Compartir por


StringBuilder.AppendFormat Método

Definición

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de un argumento de objeto correspondiente.

Sobrecargas

AppendFormat(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los argumentos mediante un proveedor de formato especificado.

AppendFormat(String, Object, Object, Object)

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los tres argumentos.

AppendFormat(IFormatProvider, String, Object, Object)

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los dos argumentos mediante un proveedor de formato especificado.

AppendFormat(String, Object, Object)

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los dos argumentos.

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

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los tres argumentos mediante un proveedor de formato especificado.

AppendFormat(IFormatProvider, CompositeFormat, Object[])

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los argumentos mediante un proveedor de formato especificado.

AppendFormat(String, ReadOnlySpan<Object>)

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de un argumento correspondiente en un intervalo de parámetros.

AppendFormat(IFormatProvider, String, Object[])

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de un argumento correspondiente en una matriz de parámetros mediante un proveedor de formato especificado.

AppendFormat(IFormatProvider, String, Object)

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de un único argumento mediante un proveedor de formato especificado.

AppendFormat(String, Object[])

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de un argumento correspondiente en una matriz de parámetros.

AppendFormat(String, Object)

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de un único argumento.

AppendFormat(IFormatProvider, String, ReadOnlySpan<Object>)

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de un argumento correspondiente en un intervalo de parámetros mediante un proveedor de formato especificado.

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

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los argumentos mediante un proveedor de formato especificado.

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

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los argumentos mediante un proveedor de formato especificado.

AppendFormat<TArg0>(IFormatProvider, CompositeFormat, TArg0)

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los argumentos mediante un proveedor de formato especificado.

AppendFormat(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los argumentos mediante un proveedor de formato especificado.

C#
public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, System.Text.CompositeFormat format, ReadOnlySpan<object?> args);
C#
public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, System.Text.CompositeFormat format, scoped ReadOnlySpan<object?> args);

Parámetros

provider
IFormatProvider

Objeto que proporciona información de formato específica de la referencia cultural.

args
ReadOnlySpan<Object>

Intervalo de objetos a los que se va a dar formato.

Devoluciones

Referencia a esta instancia una vez completada la operación de anexión.

Excepciones

format es null.

El índice de un elemento de formato es mayor o igual que el número de argumentos proporcionados.

Se aplica a

.NET 9 e .NET 8
Produto Versións
.NET 8, 9

AppendFormat(String, Object, Object, Object)

Source:
StringBuilder.cs
Source:
StringBuilder.cs
Source:
StringBuilder.cs

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los tres argumentos.

C#
public System.Text.StringBuilder AppendFormat (string format, object arg0, object arg1, object arg2);
C#
public System.Text.StringBuilder AppendFormat (string format, object? arg0, object? arg1, object? arg2);

Parámetros

format
String

Cadena de formato compuesto.

arg0
Object

Primer objeto al que se va a dar formato.

arg1
Object

Segundo objeto al que se va a dar formato.

arg2
Object

Tercer objeto al que se va a dar formato.

Devoluciones

Referencia a esta instancia con format anexados. Cada elemento de formato de format se reemplaza por la representación de cadena del argumento de objeto correspondiente.

Excepciones

format es null.

format no es válido.

-o-

El índice de un elemento de formato es menor que 0 (cero) o mayor o igual que 3.

La longitud de la cadena expandida superaría MaxCapacity.

Ejemplos

En el ejemplo siguiente se muestra el método AppendFormat.

C#
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
*/

Comentarios

Este método usa la característica de formato compuesto de .NET Framework para convertir el valor de un objeto en su representación de texto e insertar esa representación en el objeto StringBuilder actual.

El parámetro format consta de cero o más ejecuciones de texto entremezcladas con cero o más marcadores de posición indexados, denominados elementos de formato, que corresponden a arg0 a través de arg2, los objetos de la lista de parámetros de este método. El proceso de formato reemplaza cada elemento de formato por la representación de cadena del objeto correspondiente.

La sintaxis de un elemento de formato es la siguiente:

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

Los elementos entre corchetes son opcionales. En la tabla siguiente se describe cada elemento.

Elemento Descripción
de índice Posición de base cero en la lista de parámetros del objeto al que se va a dar formato. Si el objeto especificado por índice es null, el elemento de formato se reemplaza por String.Empty. Si no hay ningún parámetro en la posición índice de , se produce un .
,longitud Número mínimo de caracteres en la representación de cadena del parámetro. Si es positivo, el parámetro está alineado a la derecha; si es negativo, está alineado a la izquierda.
:formatString Cadena de formato estándar o personalizada compatible con el parámetro .

Nota

Para las cadenas de formato estándar y personalizado que se usan con valores de fecha y hora, vea cadenas de formato de fecha y hora estándar y cadenas de formato de fecha y hora personalizados. Para las cadenas de formato estándar y personalizado que se usan con valores numéricos, vea cadenas de formato numérico estándar y cadenas de formato numérico personalizado. Para ver las cadenas de formato estándar que se usan con enumeraciones, consulte cadenas de formato de enumeración.

arg0, arg1y arg2 representan los objetos a los que se va a dar formato. Cada elemento de formato de format se reemplaza por la representación de cadena de arg0, arg1o arg2, según el índice del elemento de formato. Si el elemento de formato incluye formatString y el objeto correspondiente en args implementa la interfaz IFormattable, argx.ToString(formatString, null) define el formato, donde x es el índice del argumento. De lo contrario, argx.ToString() define el formato.

Si la cadena asignada a format es "Gracias por su donación de {0:#####} cans de alimentos a nuestra organización benéfica." y arg0 es un entero con el valor 10, el valor devuelto será "Gracias por su donación de 10 canciones de alimentos a nuestra organización benéfica".

Notas a los autores de las llamadas

En .NET Core y en .NET Framework 4.0 y versiones posteriores, al crear instancias del objeto StringBuilder llamando al constructor StringBuilder(Int32, Int32), tanto la longitud como la capacidad de la instancia de StringBuilder pueden crecer más allá del valor de su propiedad MaxCapacity. Esto puede ocurrir especialmente cuando se llama a los métodos Append(String) y AppendFormat(String, Object) para anexar cadenas pequeñas.

Consulte también

Se aplica a

.NET 9 e outras versións
Produto Versións
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

AppendFormat(IFormatProvider, String, Object, Object)

Source:
StringBuilder.cs
Source:
StringBuilder.cs
Source:
StringBuilder.cs

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los dos argumentos mediante un proveedor de formato especificado.

C#
public System.Text.StringBuilder AppendFormat (IFormatProvider provider, string format, object arg0, object arg1);
C#
public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, string format, object? arg0, object? arg1);

Parámetros

provider
IFormatProvider

Objeto que proporciona información de formato específica de la referencia cultural.

format
String

Cadena de formato compuesto.

arg0
Object

Primer objeto al que se va a dar formato.

arg1
Object

Segundo objeto al que se va a dar formato.

Devoluciones

Referencia a esta instancia una vez completada la operación de anexión. Después de la operación de anexión, esta instancia contiene los datos que existían antes de la operación, sufijos por una copia de format donde cualquier especificación de formato se reemplaza por la representación de cadena del argumento de objeto correspondiente.

Excepciones

format es null.

format no es válido.

-o-

El índice de un elemento de formato es menor que 0 (cero) o mayor o igual que 2 (dos).

La longitud de la cadena expandida superaría MaxCapacity.

Ejemplos

En el ejemplo siguiente se usa el método AppendFormat(IFormatProvider, String, Object, Object) para mostrar los datos de hora y temperatura almacenados en un objeto genérico Dictionary<TKey,TValue>. Tenga en cuenta que la cadena de formato tiene tres elementos de formato, aunque solo hay objetos a los que dar formato. Esto se debe a que el primer objeto de la lista (un valor de fecha y hora) se usa en dos elementos de formato: el primer elemento de formato muestra la hora y el segundo muestra la fecha.

C#
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

Comentarios

Este método usa la característica de formato compuesto de .NET Framework para convertir el valor de un objeto en su representación de texto e insertar esa representación en el objeto StringBuilder actual.

El parámetro format consta de cero o más ejecuciones de texto entremezcladas con cero o más marcadores de posición indexados, denominados elementos de formato, que corresponden a objetos de la lista de parámetros de este método. El proceso de formato reemplaza cada elemento de formato por la representación de cadena del objeto correspondiente.

La sintaxis de un elemento de formato es la siguiente:

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

Los elementos entre corchetes son opcionales. En la tabla siguiente se describe cada elemento.

Elemento Descripción
de índice Posición de base cero en la lista de parámetros del objeto al que se va a dar formato. Si el objeto especificado por índice es null, el elemento de formato se reemplaza por String.Empty. Si no hay ningún parámetro en la posición índice de , se produce un .
,longitud Número mínimo de caracteres en la representación de cadena del parámetro. Si es positivo, el parámetro está alineado a la derecha; si es negativo, está alineado a la izquierda.
:formatString Cadena de formato estándar o personalizada compatible con el parámetro .

Nota

Para las cadenas de formato estándar y personalizado que se usan con valores de fecha y hora, vea cadenas de formato de fecha y hora estándar y cadenas de formato de fecha y hora personalizados. Para las cadenas de formato estándar y personalizado que se usan con valores numéricos, vea cadenas de formato numérico estándar y cadenas de formato numérico personalizado. Para ver las cadenas de formato estándar que se usan con enumeraciones, consulte cadenas de formato de enumeración.

El parámetro provider especifica una implementación de IFormatProvider que puede proporcionar información de formato para arg0 y arg1. provider puede ser cualquiera de los siguientes:

  • Objeto CultureInfo que proporciona información de formato específica de la referencia cultural.

  • Objeto NumberFormatInfo que proporciona información de formato específica de la referencia cultural para arg0 o arg1 si son valores numéricos.

  • Objeto DateTimeFormatInfo que proporciona información de formato específica de la referencia cultural para arg0 o arg1 si son valores de fecha y hora.

  • Implementación de IFormatProvider personalizada que proporciona información de formato para arg0 y arg1. Normalmente, esta implementación también implementa la interfaz ICustomFormatter.

Si el parámetro provider es null, la información del proveedor de formato se obtiene de la referencia cultural actual.

arg0 y arg1 representan los objetos a los que se va a dar formato. Cada elemento de formato de format se reemplaza por la representación de cadena del objeto que tiene el índice correspondiente. Si el elemento de formato incluye formatString y el argumento correspondiente implementa la interfaz IFormattable, el método ToString(formatString, provider) del argumento define el formato. De lo contrario, el método ToString() del argumento define el formato.

Notas a los autores de las llamadas

IIn .NET Core y en .NET Framework 4.0 y versiones posteriores, al crear instancias del objeto StringBuilder llamando al constructor StringBuilder(Int32, Int32), tanto la longitud como la capacidad de la instancia de StringBuilder pueden crecer más allá del valor de su propiedad MaxCapacity. Esto puede ocurrir especialmente cuando se llama a los métodos Append(String) y AppendFormat(String, Object) para anexar cadenas pequeñas.

Consulte también

Se aplica a

.NET 9 e outras versións
Produto Versións
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

AppendFormat(String, Object, Object)

Source:
StringBuilder.cs
Source:
StringBuilder.cs
Source:
StringBuilder.cs

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los dos argumentos.

C#
public System.Text.StringBuilder AppendFormat (string format, object arg0, object arg1);
C#
public System.Text.StringBuilder AppendFormat (string format, object? arg0, object? arg1);

Parámetros

format
String

Cadena de formato compuesto.

arg0
Object

Primer objeto al que se va a dar formato.

arg1
Object

Segundo objeto al que se va a dar formato.

Devoluciones

Referencia a esta instancia con format anexados. Cada elemento de formato de format se reemplaza por la representación de cadena del argumento de objeto correspondiente.

Excepciones

format es null.

format no es válido.

-o-

El índice de un elemento de formato es menor que 0 (cero) o mayor o igual que 2.

La longitud de la cadena expandida superaría MaxCapacity.

Ejemplos

En el ejemplo siguiente se muestra el método AppendFormat.

C#
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
*/

Comentarios

Este método usa la característica de formato compuesto de .NET Framework para convertir el valor de un objeto en su representación de texto e insertar esa representación en el objeto StringBuilder actual.

El parámetro format consta de cero o más ejecuciones de texto entremezcladas con cero o más marcadores de posición indexados, denominados elementos de formato, que corresponden a arg0 y arg1, los dos objetos de la lista de parámetros de este método. El proceso de formato reemplaza cada elemento de formato por la representación de cadena del objeto correspondiente.

La sintaxis de un elemento de formato es la siguiente:

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

Los elementos entre corchetes son opcionales. En la tabla siguiente se describe cada elemento.

Elemento Descripción
de índice Posición de base cero en la lista de parámetros del objeto al que se va a dar formato. Si el objeto especificado por índice es null, el elemento de formato se reemplaza por String.Empty. Si no hay ningún parámetro en la posición índice de , se produce un .
,longitud Número mínimo de caracteres en la representación de cadena del parámetro. Si es positivo, el parámetro está alineado a la derecha; si es negativo, está alineado a la izquierda.
:formatString Cadena de formato estándar o personalizada compatible con el parámetro .

Nota

Para las cadenas de formato estándar y personalizado que se usan con valores de fecha y hora, vea cadenas de formato de fecha y hora estándar y cadenas de formato de fecha y hora personalizados. Para las cadenas de formato estándar y personalizado que se usan con valores numéricos, vea cadenas de formato numérico estándar y cadenas de formato numérico personalizado. Para ver las cadenas de formato estándar que se usan con enumeraciones, consulte cadenas de formato de enumeración.

arg0 y arg1 representan los objetos a los que se va a dar formato. Cada elemento de formato de format se reemplaza por la representación de cadena de arg0 o arg1. Si el elemento de formato incluye formatString y el objeto correspondiente implementa la interfaz IFormattable, argx.ToString(formatString, provider) define el formato, donde x es el índice del argumento. De lo contrario, argx.ToString() define el formato.

Si la cadena asignada a format es "Gracias por su donación de {0:#####} cans de alimentos a nuestra organización benéfica." y arg0 es un entero con el valor 10, el valor devuelto será "Gracias por su donación de 10 canciones de alimentos a nuestra organización benéfica".

Notas a los autores de las llamadas

En .NET Core y en .NET Framework 4.0 y versiones posteriores, al crear instancias del objeto StringBuilder llamando al constructor StringBuilder(Int32, Int32), tanto la longitud como la capacidad de la instancia de StringBuilder pueden crecer más allá del valor de su propiedad MaxCapacity. Esto puede ocurrir especialmente cuando se llama a los métodos Append(String) y AppendFormat(String, Object) para anexar cadenas pequeñas.

Consulte también

Se aplica a

.NET 9 e outras versións
Produto Versións
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

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

Source:
StringBuilder.cs
Source:
StringBuilder.cs
Source:
StringBuilder.cs

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los tres argumentos mediante un proveedor de formato especificado.

C#
public System.Text.StringBuilder AppendFormat (IFormatProvider provider, string format, object arg0, object arg1, object arg2);
C#
public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, string format, object? arg0, object? arg1, object? arg2);

Parámetros

provider
IFormatProvider

Objeto que proporciona información de formato específica de la referencia cultural.

format
String

Cadena de formato compuesto.

arg0
Object

Primer objeto al que se va a dar formato.

arg1
Object

Segundo objeto al que se va a dar formato.

arg2
Object

Tercer objeto al que se va a dar formato.

Devoluciones

Referencia a esta instancia una vez completada la operación de anexión. Después de la operación de anexión, esta instancia contiene los datos que existían antes de la operación, sufijos por una copia de format donde cualquier especificación de formato se reemplaza por la representación de cadena del argumento de objeto correspondiente.

Excepciones

format es null.

format no es válido.

-o-

El índice de un elemento de formato es menor que 0 (cero) o mayor o igual que 3 (tres).

La longitud de la cadena expandida superaría MaxCapacity.

Ejemplos

En el ejemplo siguiente se usa el método AppendFormat(IFormatProvider, String, Object, Object, Object) para ilustrar el resultado de una operación de And booleana con valores enteros. Tenga en cuenta que la cadena de formato incluye seis elementos de formato, pero el método solo tiene tres elementos en su lista de argumentos, ya que cada elemento tiene formato de dos maneras diferentes.

C#
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)

Comentarios

Este método usa la característica de formato compuesto de .NET Framework para convertir el valor de un objeto en su representación de texto e insertar esa representación en el objeto StringBuilder actual.

El parámetro format consta de cero o más ejecuciones de texto entremezcladas con cero o más marcadores de posición indexados, denominados elementos de formato, que corresponden a objetos de la lista de parámetros de este método. El proceso de formato reemplaza cada elemento de formato por la representación de cadena del objeto correspondiente.

La sintaxis de un elemento de formato es la siguiente:

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

Los elementos entre corchetes son opcionales. En la tabla siguiente se describe cada elemento.

Elemento Descripción
de índice Posición de base cero en la lista de parámetros del objeto al que se va a dar formato. Si el objeto especificado por índice es null, el elemento de formato se reemplaza por String.Empty. Si no hay ningún parámetro en la posición índice de , se produce un .
,longitud Número mínimo de caracteres en la representación de cadena del parámetro. Si es positivo, el parámetro está alineado a la derecha; si es negativo, está alineado a la izquierda.
:formatString Cadena de formato estándar o personalizada compatible con el parámetro .

Nota

Para las cadenas de formato estándar y personalizado que se usan con valores de fecha y hora, vea cadenas de formato de fecha y hora estándar y cadenas de formato de fecha y hora personalizados. Para las cadenas de formato estándar y personalizado que se usan con valores numéricos, vea cadenas de formato numérico estándar y cadenas de formato numérico personalizado. Para ver las cadenas de formato estándar que se usan con enumeraciones, consulte cadenas de formato de enumeración.

El parámetro provider especifica una implementación de IFormatProvider que puede proporcionar información de formato para arg0 y arg1. provider puede ser cualquiera de los siguientes:

  • Objeto CultureInfo que proporciona información de formato específica de la referencia cultural.

  • Objeto NumberFormatInfo que proporciona información de formato específica de la referencia cultural para arg0 o arg1 si son valores numéricos.

  • Objeto DateTimeFormatInfo que proporciona información de formato específica de la referencia cultural para arg0, arg1o arg2 si son valores de fecha y hora.

  • Implementación de IFormatProvider personalizada que proporciona información de formato para arg0, arg1y arg2. Normalmente, esta implementación también implementa la interfaz ICustomFormatter.

Si el parámetro provider es null, la información del proveedor de formato se obtiene de la referencia cultural actual.

arg0, arg1y arg2 representan los objetos a los que se va a dar formato. Cada elemento de formato de format se reemplaza por la representación de cadena del objeto que tiene el índice correspondiente. Si el elemento de formato incluye formatString y el argumento correspondiente implementa la interfaz IFormattable, el método ToString(formatString, provider) del argumento define el formato. De lo contrario, el método ToString() del argumento define el formato.

Notas a los autores de las llamadas

En .NET Core y en .NET Framework 4.0 y versiones posteriores, al crear instancias del objeto StringBuilder llamando al constructor StringBuilder(Int32, Int32), tanto la longitud como la capacidad de la instancia de StringBuilder pueden crecer más allá del valor de su propiedad MaxCapacity. Esto puede ocurrir especialmente cuando se llama a los métodos Append(String) y AppendFormat(String, Object) para anexar cadenas pequeñas.

Consulte también

Se aplica a

.NET 9 e outras versións
Produto Versións
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

AppendFormat(IFormatProvider, CompositeFormat, Object[])

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los argumentos mediante un proveedor de formato especificado.

C#
public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, System.Text.CompositeFormat format, params object?[] args);

Parámetros

provider
IFormatProvider

Objeto que proporciona información de formato específica de la referencia cultural.

args
Object[]

Matriz de objetos a los que se va a dar formato.

Devoluciones

Referencia a esta instancia una vez completada la operación de anexión.

Excepciones

format o args es null.

El índice de un elemento de formato es mayor o igual que el número de argumentos proporcionados.

Se aplica a

.NET 9 e .NET 8
Produto Versións
.NET 8, 9

AppendFormat(String, ReadOnlySpan<Object>)

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de un argumento correspondiente en un intervalo de parámetros.

C#
public System.Text.StringBuilder AppendFormat (string format, scoped ReadOnlySpan<object?> args);

Parámetros

format
String

Cadena de formato compuesto.

args
ReadOnlySpan<Object>

Intervalo de objetos a los que se va a dar formato.

Devoluciones

Referencia a esta instancia una vez completada la operación de anexión.

Excepciones

format es null.

La longitud de la cadena expandida superaría MaxCapacity.

format no es válido.

-o-

El índice de un elemento de formato es menor que 0 (cero) o mayor o igual que la longitud del intervalo de args.

Se aplica a

.NET 9
Produto Versións
.NET 9

AppendFormat(IFormatProvider, String, Object[])

Source:
StringBuilder.cs
Source:
StringBuilder.cs
Source:
StringBuilder.cs

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de un argumento correspondiente en una matriz de parámetros mediante un proveedor de formato especificado.

C#
public System.Text.StringBuilder AppendFormat (IFormatProvider provider, string format, params object[] args);
C#
public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, string format, params object?[] args);

Parámetros

provider
IFormatProvider

Objeto que proporciona información de formato específica de la referencia cultural.

format
String

Cadena de formato compuesto.

args
Object[]

Matriz de objetos a los que se va a dar formato.

Devoluciones

Referencia a esta instancia una vez completada la operación de anexión. Después de la operación de anexión, esta instancia contiene los datos que existían antes de la operación, sufijos por una copia de format donde cualquier especificación de formato se reemplaza por la representación de cadena del argumento de objeto correspondiente.

Excepciones

format es null.

format no es válido.

-o-

El índice de un elemento de formato es menor que 0 (cero) o mayor o igual que la longitud de la matriz de args.

La longitud de la cadena expandida superaría MaxCapacity.

Ejemplos

En el ejemplo siguiente se muestra el método AppendFormat.

C#
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
*/

En el ejemplo siguiente se define una implementación de IFormatProvider personalizada denominada CustomerFormatter que da formato a un número de cliente de 10 dígitos con guiones después de los dígitos cuarto y séptimo. Se pasa al método StringBuilder.AppendFormat(IFormatProvider, String, Object[]) para crear una cadena que incluya el número de cliente con formato y el nombre del cliente.

C#
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

Comentarios

Este método usa la característica de formato compuesto de .NET Framework para convertir el valor de un objeto en su representación de texto e insertar esa representación en el objeto StringBuilder actual.

El parámetro format consta de cero o más ejecuciones de texto entremezcladas con cero o más marcadores de posición indexados, denominados elementos de formato, que corresponden a objetos de la lista de parámetros de este método. El proceso de formato reemplaza cada elemento de formato por la representación de cadena del objeto correspondiente.

La sintaxis de un elemento de formato es la siguiente:

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

Los elementos entre corchetes son opcionales. En la tabla siguiente se describe cada elemento.

Elemento Descripción
de índice Posición de base cero en la lista de parámetros del objeto al que se va a dar formato. Si el objeto especificado por índice es null, el elemento de formato se reemplaza por String.Empty. Si no hay ningún parámetro en la posición índice de , se produce un .
,longitud Número mínimo de caracteres en la representación de cadena del parámetro. Si es positivo, el parámetro está alineado a la derecha; si es negativo, está alineado a la izquierda.
:formatString Cadena de formato estándar o personalizada compatible con el parámetro .

Nota

Para las cadenas de formato estándar y personalizado que se usan con valores de fecha y hora, vea cadenas de formato de fecha y hora estándar y cadenas de formato de fecha y hora personalizados. Para las cadenas de formato estándar y personalizado que se usan con valores numéricos, vea cadenas de formato numérico estándar y cadenas de formato numérico personalizado. Para ver las cadenas de formato estándar que se usan con enumeraciones, consulte cadenas de formato de enumeración.

El parámetro provider especifica una implementación de IFormatProvider que puede proporcionar información de formato para los objetos de args. provider puede ser cualquiera de los siguientes:

  • Objeto CultureInfo que proporciona información de formato específica de la referencia cultural.

  • Objeto NumberFormatInfo que proporciona información de formato específica de la referencia cultural para los valores numéricos de args.

  • Objeto DateTimeFormatInfo que proporciona información de formato específica de la referencia cultural para los valores de fecha y hora en args.

  • Implementación de IFormatProvider personalizada que proporciona información de formato para uno o varios de los objetos de args. Normalmente, esta implementación también implementa la interfaz ICustomFormatter. En el segundo ejemplo de la sección siguiente se muestra una llamada al método StringBuilder.AppendFormat(IFormatProvider, String, Object[]) con una implementación de IFormatProvider personalizada.

Si el parámetro provider es null, la información del proveedor de formato se obtiene de la referencia cultural actual.

args representa los objetos a los que se va a dar formato. Cada elemento de formato de format se reemplaza por la representación de cadena del objeto correspondiente en args. Si el elemento de formato incluye formatString y el objeto correspondiente en args implementa la interfaz IFormattable, args[index].ToString(formatString, provider) define el formato. De lo contrario, args[index].ToString() define el formato.

Notas a los autores de las llamadas

En .NET Core y en .NET Framework 4.0 y versiones posteriores, al crear instancias del objeto StringBuilder llamando al constructor StringBuilder(Int32, Int32), tanto la longitud como la capacidad de la instancia de StringBuilder pueden crecer más allá del valor de su propiedad MaxCapacity. Esto puede ocurrir especialmente cuando se llama a los métodos Append(String) y AppendFormat(String, Object) para anexar cadenas pequeñas.

Consulte también

Se aplica a

.NET 9 e outras versións
Produto Versións
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

AppendFormat(IFormatProvider, String, Object)

Source:
StringBuilder.cs
Source:
StringBuilder.cs
Source:
StringBuilder.cs

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de un único argumento mediante un proveedor de formato especificado.

C#
public System.Text.StringBuilder AppendFormat (IFormatProvider provider, string format, object arg0);
C#
public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, string format, object? arg0);

Parámetros

provider
IFormatProvider

Objeto que proporciona información de formato específica de la referencia cultural.

format
String

Cadena de formato compuesto.

arg0
Object

Objeto al que se va a dar formato.

Devoluciones

Referencia a esta instancia una vez completada la operación de anexión. Después de la operación de anexión, esta instancia contiene los datos que existían antes de la operación, sufijos por una copia de format en la que cualquier especificación de formato se reemplaza por la representación de cadena de arg0.

Excepciones

format es null.

format no es válido.

-o-

El índice de un elemento de formato es menor que 0 (cero) o mayor o igual que uno (1).

La longitud de la cadena expandida superaría MaxCapacity.

Ejemplos

A continuación se incluyen dos llamadas al método AppendFormat(IFormatProvider, String, Object). Ambos usan las convenciones de formato de la referencia cultural English-United Kingdom (en-GB). La primera inserta la representación de cadena de una moneda de valor de Decimal en una cadena de resultado. El segundo inserta un valor de DateTime en dos lugares en una cadena de resultado, el primero incluye solo la cadena de fecha corta y la segunda la cadena de tiempo corta.

C#
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

Comentarios

Este método usa la característica de formato compuesto de .NET Framework para convertir el valor de arg0 en su representación de texto e insertar esa representación en el objeto StringBuilder actual.

El parámetro format consta de cero o más ejecuciones de texto entremezcladas con cero o más marcadores de posición indexados, denominados elementos de formato. El índice de cada elemento de formato debe ser cero (0), ya que este método incluye una lista de argumentos con un único argumento. El proceso de formato reemplaza cada elemento de formato por la representación de cadena de arg0.

La sintaxis de un elemento de formato es la siguiente:

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

Los elementos entre corchetes son opcionales. En la tabla siguiente se describe cada elemento.

Elemento Descripción
de índice Posición de base cero en la lista de parámetros del objeto al que se va a dar formato. Si el objeto especificado por índice es null, el elemento de formato se reemplaza por String.Empty. En este caso, dado que el método AppendFormat(IFormatProvider, String, Object) tiene un único argumento en la lista de argumentos, el valor de índice siempre debe ser 0. Si no es así, se produce un FormatException.
,longitud Número mínimo de caracteres en la representación de cadena del parámetro. Si es positivo, el parámetro está alineado a la derecha; si es negativo, está alineado a la izquierda.
:formatString Cadena de formato estándar o personalizada compatible con el parámetro .

Nota

Para las cadenas de formato estándar y personalizado que se usan con valores de fecha y hora, vea cadenas de formato de fecha y hora estándar y cadenas de formato de fecha y hora personalizados. Para las cadenas de formato estándar y personalizado que se usan con valores numéricos, vea cadenas de formato numérico estándar y cadenas de formato numérico personalizado. Para ver las cadenas de formato estándar que se usan con enumeraciones, consulte cadenas de formato de enumeración.

El parámetro provider especifica una implementación de IFormatProvider que puede proporcionar información de formato para los objetos de args. provider puede ser cualquiera de los siguientes:

  • Objeto CultureInfo que proporciona información de formato específica de la referencia cultural.

  • Objeto NumberFormatInfo que proporciona información de formato específica de la referencia cultural para arg0 si es un valor numérico.

  • Objeto DateTimeFormatInfo que proporciona información de formato específica de la referencia cultural para arg0 si es un valor de fecha y hora.

  • Implementación de IFormatProvider personalizada que proporciona información de formato para arg0. Normalmente, esta implementación también implementa la interfaz ICustomFormatter.

Si el parámetro provider es null, la información de formato se obtiene de la referencia cultural actual.

arg0 representa el objeto al que se va a dar formato. Cada elemento de formato de format se reemplaza por la representación de cadena de arg0. Si el elemento de formato incluye formatString y arg0 implementa la interfaz IFormattable, arg0.ToString(formatString, provider) define el formato. De lo contrario, arg0.ToString() define el formato.

Notas a los autores de las llamadas

En .NET Core y en .NET Framework 4.0 y versiones posteriores, al crear instancias del objeto StringBuilder llamando al constructor StringBuilder(Int32, Int32), tanto la longitud como la capacidad de la instancia de StringBuilder pueden crecer más allá del valor de su propiedad MaxCapacity. Esto puede ocurrir especialmente cuando se llama a los métodos Append(String) y AppendFormat(String, Object) para anexar cadenas pequeñas.

Consulte también

Se aplica a

.NET 9 e outras versións
Produto Versións
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

AppendFormat(String, Object[])

Source:
StringBuilder.cs
Source:
StringBuilder.cs
Source:
StringBuilder.cs

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de un argumento correspondiente en una matriz de parámetros.

C#
public System.Text.StringBuilder AppendFormat (string format, params object[] args);
C#
public System.Text.StringBuilder AppendFormat (string format, params object?[] args);

Parámetros

format
String

Cadena de formato compuesto.

args
Object[]

Matriz de objetos a los que se va a dar formato.

Devoluciones

Referencia a esta instancia con format anexados. Cada elemento de formato de format se reemplaza por la representación de cadena del argumento de objeto correspondiente.

Excepciones

format o args es null.

format no es válido.

-o-

El índice de un elemento de formato es menor que 0 (cero) o mayor o igual que la longitud de la matriz de args.

La longitud de la cadena expandida superaría MaxCapacity.

Ejemplos

En el ejemplo siguiente se muestra el método AppendFormat.

C#
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
*/

Comentarios

Este método usa la característica de formato compuesto de .NET Framework para convertir el valor de un objeto en su representación de texto e insertar esa representación en el objeto StringBuilder actual.

El parámetro format consta de cero o más ejecuciones de texto entremezcladas con cero o más marcadores de posición indexados, denominados elementos de formato, que corresponden a objetos de la lista de parámetros de este método. El proceso de formato reemplaza cada elemento de formato por la representación de cadena del objeto correspondiente.

La sintaxis de un elemento de formato es la siguiente:

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

Los elementos entre corchetes son opcionales. En la tabla siguiente se describe cada elemento.

Elemento Descripción
de índice Posición de base cero en la lista de parámetros del objeto al que se va a dar formato. Si el objeto especificado por índice es null, el elemento de formato se reemplaza por String.Empty. Si no hay ningún parámetro en la posición índice de , se produce un .
,longitud Número mínimo de caracteres en la representación de cadena del parámetro. Si es positivo, el parámetro está alineado a la derecha; si es negativo, está alineado a la izquierda.
:formatString Cadena de formato estándar o personalizada compatible con el parámetro .

Nota

Para las cadenas de formato estándar y personalizado que se usan con valores de fecha y hora, vea cadenas de formato de fecha y hora estándar y cadenas de formato de fecha y hora personalizados. Para las cadenas de formato estándar y personalizado que se usan con valores numéricos, vea cadenas de formato numérico estándar y cadenas de formato numérico personalizado. Para ver las cadenas de formato estándar que se usan con enumeraciones, consulte cadenas de formato de enumeración.

args representa los objetos a los que se va a dar formato. Cada elemento de formato de format se reemplaza por la representación de cadena del objeto correspondiente en args. Si el elemento de formato incluye formatString y el objeto correspondiente en args implementa la interfaz IFormattable, args[index].ToString(formatString, provider) define el formato. De lo contrario, args[index].ToString() define el formato.

Si la cadena asignada a format es "Gracias por su donación de {0:#####} cans de alimentos a nuestra organización benéfica." y arg0 es un entero con el valor 10, el valor devuelto será "Gracias por su donación de 10 canciones de alimentos a nuestra organización benéfica".

Notas a los autores de las llamadas

En .NET Core y en .NET Framework 4.0 y versiones posteriores, al crear instancias del objeto StringBuilder llamando al constructor StringBuilder(Int32, Int32), tanto la longitud como la capacidad de la instancia de StringBuilder pueden crecer más allá del valor de su propiedad MaxCapacity. Esto puede ocurrir especialmente cuando se llama a los métodos Append(String) y AppendFormat(String, Object) para anexar cadenas pequeñas.

Consulte también

Se aplica a

.NET 9 e outras versións
Produto Versións
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

AppendFormat(String, Object)

Source:
StringBuilder.cs
Source:
StringBuilder.cs
Source:
StringBuilder.cs

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de un único argumento.

C#
public System.Text.StringBuilder AppendFormat (string format, object arg0);
C#
public System.Text.StringBuilder AppendFormat (string format, object? arg0);

Parámetros

format
String

Cadena de formato compuesto.

arg0
Object

Objeto al que se va a dar formato.

Devoluciones

Referencia a esta instancia con format anexados. Cada elemento de formato de format se reemplaza por la representación de cadena de arg0.

Excepciones

format es null.

format no es válido.

-o-

El índice de un elemento de formato es menor que 0 (cero) o mayor o igual que 1.

La longitud de la cadena expandida superaría MaxCapacity.

Ejemplos

En el ejemplo siguiente se muestra el método AppendFormat.

C#
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
*/

Comentarios

Este método usa la característica de formato compuesto de .NET Framework para convertir el valor de un objeto en su representación de texto e insertar esa representación en el objeto StringBuilder actual.

El parámetro format consta de cero o más ejecuciones de texto entremezcladas con cero o más marcadores de posición indexados, denominados elementos de formato. El índice de los elementos de formato debe ser 0, para corresponder a arg0, el único objeto de la lista de parámetros de este método. El proceso de formato reemplaza cada elemento de formato por la representación de cadena de arg0.

La sintaxis de un elemento de formato es la siguiente:

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

Los elementos entre corchetes son opcionales. En la tabla siguiente se describe cada elemento.

Elemento Descripción
de índice Posición de base cero en la lista de parámetros del objeto al que se va a dar formato. Si el objeto especificado por índice es null, el elemento de formato se reemplaza por String.Empty. Si no hay ningún parámetro en la posición índice de , se produce un .
,longitud Número mínimo de caracteres en la representación de cadena del parámetro. Si es positivo, el parámetro está alineado a la derecha; si es negativo, está alineado a la izquierda.
:formatString Cadena de formato estándar o personalizada compatible con el parámetro .

Nota

Para las cadenas de formato estándar y personalizado que se usan con valores de fecha y hora, vea cadenas de formato de fecha y hora estándar y cadenas de formato de fecha y hora personalizados. Para las cadenas de formato estándar y personalizado que se usan con valores numéricos, vea cadenas de formato numérico estándar y cadenas de formato numérico personalizado. Para ver las cadenas de formato estándar que se usan con enumeraciones, consulte cadenas de formato de enumeración.

arg0 representa el objeto al que se va a dar formato. Cada elemento de formato de format se reemplaza por la representación de cadena de arg0. Si el elemento de formato incluye formatString y arg0 implementa la interfaz IFormattable, arg0.ToString(formatString, null) define el formato. De lo contrario, arg0.ToString() define el formato.

Si la cadena asignada a format es "Gracias por su donación de {0:#####} cans de alimentos a nuestra organización benéfica." y arg0 es un entero con el valor 10, el valor devuelto será "Gracias por su donación de 10 canciones de alimentos a nuestra organización benéfica".

Notas a los autores de las llamadas

En .NET Core y en .NET Framework 4.0 y versiones posteriores, al crear instancias del objeto StringBuilder llamando al constructor StringBuilder(Int32, Int32), tanto la longitud como la capacidad de la instancia de StringBuilder pueden crecer más allá del valor de su propiedad MaxCapacity. Esto puede ocurrir especialmente cuando se llama a los métodos Append(String) y AppendFormat(String, Object) para anexar cadenas pequeñas.

Consulte también

Se aplica a

.NET 9 e outras versións
Produto Versións
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

AppendFormat(IFormatProvider, String, ReadOnlySpan<Object>)

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de un argumento correspondiente en un intervalo de parámetros mediante un proveedor de formato especificado.

C#
public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, string format, scoped ReadOnlySpan<object?> args);

Parámetros

provider
IFormatProvider

Objeto que proporciona información de formato específica de la referencia cultural.

format
String

Cadena de formato compuesto.

args
ReadOnlySpan<Object>

Intervalo de objetos a los que se va a dar formato.

Devoluciones

Referencia a esta instancia una vez completada la operación de anexión.

Excepciones

format es null.

La longitud de la cadena expandida superaría MaxCapacity.

format no es válido.

-o-

El índice de un elemento de formato es menor que 0 (cero) o mayor o igual que la longitud del intervalo de args.

Se aplica a

.NET 9
Produto Versións
.NET 9

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

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los argumentos mediante un proveedor de formato especificado.

C#
public System.Text.StringBuilder AppendFormat<TArg0,TArg1,TArg2> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0, TArg1 arg1, TArg2 arg2);

Parámetros de tipo

TArg0

Tipo del primer objeto al que se va a dar formato.

TArg1

Tipo del segundo objeto al que se va a dar formato.

TArg2

Tipo del tercer objeto al que se va a dar formato.

Parámetros

provider
IFormatProvider

Objeto que proporciona información de formato específica de la referencia cultural.

arg0
TArg0

Primer objeto al que se va a dar formato.

arg1
TArg1

Segundo objeto al que se va a dar formato.

arg2
TArg2

Tercer objeto al que se va a dar formato.

Devoluciones

Referencia a esta instancia una vez completada la operación de anexión.

Excepciones

format es null.

El índice de un elemento de formato es mayor o igual que el número de argumentos proporcionados.

Se aplica a

.NET 9 e .NET 8
Produto Versións
.NET 8, 9

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

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los argumentos mediante un proveedor de formato especificado.

C#
public System.Text.StringBuilder AppendFormat<TArg0,TArg1> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0, TArg1 arg1);

Parámetros de tipo

TArg0

Tipo del primer objeto al que se va a dar formato.

TArg1

Tipo del segundo objeto al que se va a dar formato.

Parámetros

provider
IFormatProvider

Objeto que proporciona información de formato específica de la referencia cultural.

arg0
TArg0

Primer objeto al que se va a dar formato.

arg1
TArg1

Segundo objeto al que se va a dar formato.

Devoluciones

Referencia a esta instancia una vez completada la operación de anexión.

Excepciones

format es null.

El índice de un elemento de formato es mayor o igual que el número de argumentos proporcionados.

Se aplica a

.NET 9 e .NET 8
Produto Versións
.NET 8, 9

AppendFormat<TArg0>(IFormatProvider, CompositeFormat, TArg0)

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Anexa la cadena devuelta mediante el procesamiento de una cadena de formato compuesto, que contiene cero o más elementos de formato, a esta instancia. Cada elemento de formato se reemplaza por la representación de cadena de cualquiera de los argumentos mediante un proveedor de formato especificado.

C#
public System.Text.StringBuilder AppendFormat<TArg0> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0);

Parámetros de tipo

TArg0

Tipo del primer objeto al que se va a dar formato.

Parámetros

provider
IFormatProvider

Objeto que proporciona información de formato específica de la referencia cultural.

arg0
TArg0

Primer objeto al que se va a dar formato.

Devoluciones

Referencia a esta instancia una vez completada la operación de anexión.

Excepciones

format es null.

El índice de un elemento de formato es mayor o igual que el número de argumentos proporcionados.

Se aplica a

.NET 9 e .NET 8
Produto Versións
.NET 8, 9