Este artículo se tradujo automáticamente. Para ver el artículo en inglés, active la casilla Inglés. Además, puede mostrar el texto en inglés en una ventana emergente si mueve el puntero del mouse sobre el texto.
Traducción
Inglés

Método StringBuilder.AppendFormat (String, Object[])

 

Publicado: octubre de 2016

Anexa a esta instancia la cadena que se devuelve al procesar una cadena con formato compuesto, que contiene cero o más elementos de formato. Cada elemento de formato se reemplaza por la representación de cadena del argumento correspondiente de una matriz de parámetros.

Espacio de nombres:   System.Text
Ensamblado:  mscorlib (en mscorlib.dll)

public StringBuilder AppendFormat(
	string format,
	params object[] args
)

Parámetros

format
Type: System.String

Cadena de formato compuesto (vea Comentarios).

args
Type: System.Object[]

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

Valor devuelto

Type: System.Text.StringBuilder

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

Exception Condition
ArgumentNullException

El valor de format o args es null.

FormatException

format no es válido.

O bien

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

ArgumentOutOfRangeException

La longitud de la cadena expandida superaría MaxCapacity.

This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current T:System.Text.StringBuilder object.

The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to objects in the parameter list of this method. The formatting process replaces each format item with the string representation of the corresponding object.

The syntax of a format item is as follows:

{index[,length][:formatString]}

Elements in square brackets are optional. The following table describes each element.

Element

Description

index

The zero-based position in the parameter list of the object to be formatted. If the object specified by index is null, the format item is replaced by F:System.String.Empty. If there is no parameter in the index position, a T:System.FormatException is thrown.

,length

The minimum number of characters in the string representation of the parameter. If positive, the parameter is right-aligned; if negative, it is left-aligned.

:formatString

A standard or custom format string that is supported by the parameter.

System_CAPS_noteNota

For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. For the standard format strings used with enumerations, see Enumeration Format Strings.

args represents the objects to be formatted. Each format item in format is replaced with the string representation of the corresponding object in args. If the format item includes formatString and the corresponding object in args implements the IFormattable interface, then args[index].ToString(formatString, provider) defines the formatting. Otherwise, args[index].ToString() defines the formatting.

If the string assigned to format is "Thank you for your donation of {0:####} cans of food to our charitable organization." and arg0 is an integer with the value 10, the return value will be "Thank you for your donation of 10 cans of food to our charitable organization."

Notas para llamadores:

In thenet_v40_short and the net_v45, when you instantiate the T:System.Text.StringBuilder object by calling the M:System.Text.StringBuilder.#ctor(System.Int32,System.Int32) constructor, both the length and the capacity of the T:System.Text.StringBuilder instance can grow beyond the value of its P:System.Text.StringBuilder.MaxCapacity property. This can occur particularly when you call the M:System.Text.StringBuilder.Append(System.String) and M:System.Text.StringBuilder.AppendFormat(System.String,System.Object) methods to append small strings.

The following example demonstrates the Overload:System.Text.StringBuilder.AppendFormat method.

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

Plataforma universal de Windows
Disponible desde 8
.NET Framework
Disponible desde 1.1
Biblioteca de clases portable
Se admite en: plataformas portátiles de .NET
Silverlight
Disponible desde 2.0
Windows Phone Silverlight
Disponible desde 7.0
Windows Phone
Disponible desde 8.1
Volver al principio
Mostrar: