StringBuilder.AppendFormat, méthode (String, Object, Object)

Cette méthode utilise la fonctionnalité de mise en forme composite du .NET Framework pour convertir la valeur d'un objet en sa représentation textuelle et incorporer cette représentation dans l'objet StringBuilder actuel.

Le paramètre format se compose de zéro ou de plusieurs exécutions de texte associées à zéro ou de plusieurs espaces réservés indexés, appelés éléments de format, qui correspondent à arg0 et arg1, les deux objets de la liste de paramètres de cette méthode. Le processus de mise en forme remplace chaque élément de mise en forme par la représentation sous forme de chaîne de l'objet correspondant.

La syntaxe d'un élément de mise en forme est la suivante :

{index[,length][:formatString]}

Les éléments entre crochets sont facultatifs. Le tableau suivant décrit les différents éléments.

Remarque

Pour connaître les chaînes de format standard et personnalisées utilisées avec les valeurs de date et d'heure, consultez Chaînes de format de date et d'heure standard et Chaînes de format de date et d'heure personnalisées. Pour connaître les chaînes de format standard et personnalisées utilisées avec les valeurs numériques, consultez Chaînes de format numériques standard et Chaînes de format numériques personnalisées. Pour connaître les chaînes de format standard utilisées avec les énumérations, consultez Chaînes de format d'énumération.

arg0 et arg1 représentent les objets à mettre en forme. Chaque élément de mise en forme dans format est remplacé par la représentation sous forme de chaîne d'arg0 ou d'arg1. Si l'élément de mise en forme inclut formatString et l'objet correspondant implémente l'interface IFormattable, alors arg, x.ToString(formatString, provider) définit la mise en forme, où x est l'index de l'argument. Dans le cas contraire, arg.ToString(provider) définit la mise en forme.

Si la chaîne assignée à format est « merci de votre donation de {0 : boîtes de conserve de ####} à notre organisation charitable ». et arg0 est un entier avec la valeur 10, la valeur de retour est « vous remercient de votre donation de 10 boîtes de conserve à notre organisation charitable ».

Dans .NET Framework 4 et .NET Framework 4.5, lorsque vous instanciez l'objet d' StringBuilder en appelant le constructeur d' StringBuilder(Int32, Int32) , la longueur et l'instance d' StringBuilder peuvent étendre au delà de la valeur de sa propriété d' MaxCapacity . Cela peut se produire en particulier lorsque vous appelez des méthodes d' Append et d' AppendFormat pour ajouter des petites chaînes.

L'exemple de code suivant illustre la méthode AppendFormat.

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

.NET Framework

.NET Framework Client Profile

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (rôle principal du serveur non pris en charge), Windows Server 2008 R2 (rôle principal du serveur pris en charge avec SP1 ou version ultérieure ; Itanium non pris en charge)

Référence

Autres ressources