Lire en anglais

Partager via


StringBuilder.AppendFormat Méthode

Définition

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un argument d’objet correspondant.

Surcharges

AppendFormat(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des arguments à l’aide d’un fournisseur de format spécifié.

AppendFormat(String, Object, Object, Object)

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des trois arguments.

AppendFormat(IFormatProvider, String, Object, Object)

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des deux arguments à l’aide d’un fournisseur de format spécifié.

AppendFormat(String, Object, Object)

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des deux arguments.

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

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des trois arguments à l’aide d’un fournisseur de format spécifié.

AppendFormat(IFormatProvider, CompositeFormat, Object[])

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des arguments à l’aide d’un fournisseur de format spécifié.

AppendFormat(String, ReadOnlySpan<Object>)

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un argument correspondant dans une étendue de paramètre.

AppendFormat(IFormatProvider, String, Object[])

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un argument correspondant dans un tableau de paramètres à l’aide d’un fournisseur de format spécifié.

AppendFormat(IFormatProvider, String, Object)

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un seul argument à l’aide d’un fournisseur de format spécifié.

AppendFormat(String, Object[])

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un argument correspondant dans un tableau de paramètres.

AppendFormat(String, Object)

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un seul argument.

AppendFormat(IFormatProvider, String, ReadOnlySpan<Object>)

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un argument correspondant dans une étendue de paramètre à l’aide d’un fournisseur de format spécifié.

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

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des arguments à l’aide d’un fournisseur de format spécifié.

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

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des arguments à l’aide d’un fournisseur de format spécifié.

AppendFormat<TArg0>(IFormatProvider, CompositeFormat, TArg0)

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des arguments à l’aide d’un fournisseur de format spécifié.

AppendFormat(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des arguments à l’aide d’un fournisseur de format spécifié.

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);

Paramètres

provider
IFormatProvider

Objet qui fournit des informations de mise en forme propres à la culture.

args
ReadOnlySpan<Object>

Étendue d’objets à mettre en forme.

Retours

Référence à cette instance une fois l’opération d’ajout terminée.

Exceptions

format est null.

L’index d’un élément de format est supérieur ou égal au nombre d’arguments fournis.

S’applique à

.NET 9 et .NET 8
Produit Versions
.NET 8, 9

AppendFormat(String, Object, Object, Object)

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

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des trois arguments.

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);

Paramètres

format
String

Chaîne de format composite.

arg0
Object

Premier objet à mettre en forme.

arg1
Object

Deuxième objet à mettre en forme.

arg2
Object

Troisième objet à mettre en forme.

Retours

Référence à cette instance avec format ajouté. Chaque élément de format de format est remplacé par la représentation sous forme de chaîne de l’argument objet correspondant.

Exceptions

format est null.

format n’est pas valide.

-ou-

L’index d’un élément de format est inférieur à 0 (zéro) ou supérieur ou égal à 3.

La longueur de la chaîne développée dépasserait MaxCapacity.

Exemples

L’exemple suivant illustre la méthode 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
*/

Remarques

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 plusieurs exécutions de texte mélangées avec zéro ou plus d’espaces réservés indexés, appelés éléments de format, qui correspondent à arg0 via arg2, les objets de la liste de paramètres de cette méthode. Le processus de mise en forme remplace chaque élément de format par la représentation sous forme de chaîne de l’objet correspondant.

La syntaxe d’un élément de format est la suivante :

{index[,longueur][ :formatString]}

Les éléments entre crochets sont facultatifs. Le tableau suivant décrit chaque élément.

Élément Description
d’index Position de base zéro dans la liste de paramètres de l’objet à mettre en forme. Si l’objet spécifié par index est null, l’élément de format est remplacé par String.Empty. S’il n’existe aucun paramètre dans l’index position, une FormatException est levée.
,longueur Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre. S’il est positif, le paramètre est aligné à droite ; s’il est négatif, il est aligné à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.

Note

Pour connaître les chaînes de format standard et personnalisées utilisées avec des 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 des valeurs numériques, consultez chaînes de format numérique standard et chaînes de format numérique personnalisées. Pour connaître les chaînes de format standard utilisées avec des énumérations, consultez chaînes de format d’énumération.

arg0, arg1et arg2 représentent les objets à mettre en forme. Chaque élément de format dans format est remplacé par la représentation sous forme de chaîne de arg0, de arg1ou de arg2, en fonction de l’index de l’élément de format. Si l’élément de format inclut formatString et l’objet correspondant dans args implémente l’interface IFormattable, argx.ToString(formatString, null) définit la mise en forme, où x est l’index de l’argument. Sinon, argx.ToString() définit la mise en forme.

Si la chaîne attribuée à format est « Merci pour votre don de {0 :####} cans de nourriture à notre organisation caritative ». Et arg0 est un entier avec la valeur 10, la valeur de retour sera « Merci pour votre don de 10 canons de nourriture à notre organisation caritative ».

Notes pour les appelants

Dans .NET Core et dans .NET Framework 4.0 et versions ultérieures, lorsque vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent dépasser la valeur de sa propriété MaxCapacity. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

.NET 9 et autres versions
Produit Versions
.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

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des deux arguments à l’aide d’un fournisseur de format spécifié.

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);

Paramètres

provider
IFormatProvider

Objet qui fournit des informations de mise en forme propres à la culture.

format
String

Chaîne de format composite.

arg0
Object

Premier objet à mettre en forme.

arg1
Object

Deuxième objet à mettre en forme.

Retours

Référence à cette instance une fois l’opération d’ajout terminée. Après l’opération d’ajout, cette instance contient toutes les données qui existaient avant l’opération, suffixees par une copie de format où toute spécification de format est remplacée par la représentation sous forme de chaîne de l’argument objet correspondant.

Exceptions

format est null.

format n’est pas valide.

-ou-

L’index d’un élément de format est inférieur à 0 (zéro) ou supérieur ou égal à 2 (deux).

La longueur de la chaîne développée dépasserait MaxCapacity.

Exemples

L’exemple suivant utilise la méthode AppendFormat(IFormatProvider, String, Object, Object) pour afficher les données de temps et de température stockées dans un objet Dictionary<TKey,TValue> générique. Notez que la chaîne de format comporte trois éléments de format, bien qu’il n’y ait que des objets à mettre en forme. Cela est dû au fait que le premier objet de la liste (valeur de date et d’heure) est utilisé par deux éléments de format : le premier élément de format affiche l’heure et le second affiche la date.

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

Remarques

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 plusieurs exécutions de texte mélangées avec zéro ou plus d’espaces réservés indexés, appelés éléments de format, qui correspondent aux objets de la liste de paramètres de cette méthode. Le processus de mise en forme remplace chaque élément de format par la représentation sous forme de chaîne de l’objet correspondant.

La syntaxe d’un élément de format est la suivante :

{index[,longueur][ :formatString]}

Les éléments entre crochets sont facultatifs. Le tableau suivant décrit chaque élément.

Élément Description
d’index Position de base zéro dans la liste de paramètres de l’objet à mettre en forme. Si l’objet spécifié par index est null, l’élément de format est remplacé par String.Empty. S’il n’existe aucun paramètre dans l’index position, une FormatException est levée.
,longueur Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre. S’il est positif, le paramètre est aligné à droite ; s’il est négatif, il est aligné à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.

Note

Pour connaître les chaînes de format standard et personnalisées utilisées avec des 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 des valeurs numériques, consultez chaînes de format numérique standard et chaînes de format numérique personnalisées. Pour connaître les chaînes de format standard utilisées avec des énumérations, consultez chaînes de format d’énumération.

Le paramètre provider spécifie une implémentation IFormatProvider qui peut fournir des informations de mise en forme pour arg0 et arg1. provider peut être l’une des options suivantes :

  • Objet CultureInfo qui fournit des informations de mise en forme spécifiques à la culture.

  • Objet NumberFormatInfo qui fournit des informations de mise en forme spécifiques à la culture pour arg0 ou arg1 s’il s’agit de valeurs numériques.

  • Objet DateTimeFormatInfo qui fournit des informations de mise en forme spécifiques à la culture pour arg0 ou arg1 s’ils sont des valeurs de date et d’heure.

  • Implémentation IFormatProvider personnalisée qui fournit des informations de mise en forme pour arg0 et arg1. En règle générale, une telle implémentation implémente également l’interface ICustomFormatter.

Si le paramètre provider est null, les informations du fournisseur de format sont obtenues à partir de la culture actuelle.

arg0 et arg1 représentent les objets à mettre en forme. Chaque élément de format dans format est remplacé par la représentation sous forme de chaîne de l’objet qui a l’index correspondant. Si l’élément de format inclut formatString et que l’argument correspondant implémente l’interface IFormattable, la méthode ToString(formatString, provider) de l’argument définit la mise en forme. Sinon, la méthode ToString() de l’argument définit la mise en forme.

Notes pour les appelants

IIn .NET Core et dans .NET Framework 4.0 et versions ultérieures, lorsque vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent augmenter au-delà de la valeur de sa propriété MaxCapacity. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

.NET 9 et autres versions
Produit Versions
.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

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des deux arguments.

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

Paramètres

format
String

Chaîne de format composite.

arg0
Object

Premier objet à mettre en forme.

arg1
Object

Deuxième objet à mettre en forme.

Retours

Référence à cette instance avec format ajouté. Chaque élément de format de format est remplacé par la représentation sous forme de chaîne de l’argument objet correspondant.

Exceptions

format est null.

format n’est pas valide.

-ou-

L’index d’un élément de format est inférieur à 0 (zéro) ou supérieur ou égal à 2.

La longueur de la chaîne développée dépasserait MaxCapacity.

Exemples

L’exemple suivant illustre la méthode 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
*/

Remarques

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 plusieurs exécutions de texte mélangées avec zéro ou plus d’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 format par la représentation sous forme de chaîne de l’objet correspondant.

La syntaxe d’un élément de format est la suivante :

{index[,longueur][ :formatString]}

Les éléments entre crochets sont facultatifs. Le tableau suivant décrit chaque élément.

Élément Description
d’index Position de base zéro dans la liste de paramètres de l’objet à mettre en forme. Si l’objet spécifié par index est null, l’élément de format est remplacé par String.Empty. S’il n’existe aucun paramètre dans l’index position, une FormatException est levée.
,longueur Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre. S’il est positif, le paramètre est aligné à droite ; s’il est négatif, il est aligné à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.

Note

Pour connaître les chaînes de format standard et personnalisées utilisées avec des 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 des valeurs numériques, consultez chaînes de format numérique standard et chaînes de format numérique personnalisées. Pour connaître les chaînes de format standard utilisées avec des énumérations, consultez chaînes de format d’énumération.

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

Si la chaîne attribuée à format est « Merci pour votre don de {0 :####} cans de nourriture à notre organisation caritative ». Et arg0 est un entier avec la valeur 10, la valeur de retour sera « Merci pour votre don de 10 canons de nourriture à notre organisation caritative ».

Notes pour les appelants

Dans .NET Core et dans .NET Framework 4.0 et versions ultérieures, lorsque vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent dépasser la valeur de sa propriété MaxCapacity. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

.NET 9 et autres versions
Produit Versions
.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

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des trois arguments à l’aide d’un fournisseur de format spécifié.

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);

Paramètres

provider
IFormatProvider

Objet qui fournit des informations de mise en forme propres à la culture.

format
String

Chaîne de format composite.

arg0
Object

Premier objet à mettre en forme.

arg1
Object

Deuxième objet à mettre en forme.

arg2
Object

Troisième objet à mettre en forme.

Retours

Référence à cette instance une fois l’opération d’ajout terminée. Après l’opération d’ajout, cette instance contient toutes les données qui existaient avant l’opération, suffixees par une copie de format où toute spécification de format est remplacée par la représentation sous forme de chaîne de l’argument objet correspondant.

Exceptions

format est null.

format n’est pas valide.

-ou-

L’index d’un élément de format est inférieur à 0 (zéro), ou supérieur ou égal à 3 (trois).

La longueur de la chaîne développée dépasserait MaxCapacity.

Exemples

L’exemple suivant utilise la méthode AppendFormat(IFormatProvider, String, Object, Object, Object) pour illustrer le résultat d’une opération de And booléenne avec des valeurs entières. Notez que la chaîne de format inclut six éléments de format, mais que la méthode ne comporte que trois éléments dans sa liste d’arguments, car chaque élément est mis en forme de deux façons différentes.

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)

Remarques

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 plusieurs exécutions de texte mélangées avec zéro ou plus d’espaces réservés indexés, appelés éléments de format, qui correspondent aux objets de la liste de paramètres de cette méthode. Le processus de mise en forme remplace chaque élément de format par la représentation sous forme de chaîne de l’objet correspondant.

La syntaxe d’un élément de format est la suivante :

{index[,longueur][ :formatString]}

Les éléments entre crochets sont facultatifs. Le tableau suivant décrit chaque élément.

Élément Description
d’index Position de base zéro dans la liste de paramètres de l’objet à mettre en forme. Si l’objet spécifié par index est null, l’élément de format est remplacé par String.Empty. S’il n’existe aucun paramètre dans l’index position, une FormatException est levée.
,longueur Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre. S’il est positif, le paramètre est aligné à droite ; s’il est négatif, il est aligné à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.

Note

Pour connaître les chaînes de format standard et personnalisées utilisées avec des 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 des valeurs numériques, consultez chaînes de format numérique standard et chaînes de format numérique personnalisées. Pour connaître les chaînes de format standard utilisées avec des énumérations, consultez chaînes de format d’énumération.

Le paramètre provider spécifie une implémentation IFormatProvider qui peut fournir des informations de mise en forme pour arg0 et arg1. provider peut être l’une des options suivantes :

  • Objet CultureInfo qui fournit des informations de mise en forme spécifiques à la culture.

  • Objet NumberFormatInfo qui fournit des informations de mise en forme spécifiques à la culture pour arg0 ou arg1 s’il s’agit de valeurs numériques.

  • Objet DateTimeFormatInfo qui fournit des informations de mise en forme spécifiques à la culture pour arg0, arg1ou arg2 s’ils sont des valeurs de date et d’heure.

  • Implémentation IFormatProvider personnalisée qui fournit des informations de mise en forme pour arg0, arg1et arg2. En règle générale, une telle implémentation implémente également l’interface ICustomFormatter.

Si le paramètre provider est null, les informations du fournisseur de format sont obtenues à partir de la culture actuelle.

arg0, arg1et arg2 représentent les objets à mettre en forme. Chaque élément de format dans format est remplacé par la représentation sous forme de chaîne de l’objet qui a l’index correspondant. Si l’élément de format inclut formatString et que l’argument correspondant implémente l’interface IFormattable, la méthode ToString(formatString, provider) de l’argument définit la mise en forme. Sinon, la méthode ToString() de l’argument définit la mise en forme.

Notes pour les appelants

Dans .NET Core et dans .NET Framework 4.0 et versions ultérieures, lorsque vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent dépasser la valeur de sa propriété MaxCapacity. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

.NET 9 et autres versions
Produit Versions
.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

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des arguments à l’aide d’un fournisseur de format spécifié.

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

Paramètres

provider
IFormatProvider

Objet qui fournit des informations de mise en forme propres à la culture.

args
Object[]

Tableau d’objets à mettre en forme.

Retours

Référence à cette instance une fois l’opération d’ajout terminée.

Exceptions

format ou args est null.

L’index d’un élément de format est supérieur ou égal au nombre d’arguments fournis.

S’applique à

.NET 9 et .NET 8
Produit Versions
.NET 8, 9

AppendFormat(String, ReadOnlySpan<Object>)

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un argument correspondant dans une étendue de paramètre.

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

Paramètres

format
String

Chaîne de format composite.

args
ReadOnlySpan<Object>

Étendue d’objets à mettre en forme.

Retours

Référence à cette instance une fois l’opération d’ajout terminée.

Exceptions

format est null.

La longueur de la chaîne développée dépasserait MaxCapacity.

format n’est pas valide.

-ou-

L’index d’un élément de format est inférieur à 0 (zéro), ou supérieur ou égal à la longueur de l’étendue args.

S’applique à

.NET 9
Produit Versions
.NET 9

AppendFormat(IFormatProvider, String, Object[])

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

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un argument correspondant dans un tableau de paramètres à l’aide d’un fournisseur de format spécifié.

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);

Paramètres

provider
IFormatProvider

Objet qui fournit des informations de mise en forme propres à la culture.

format
String

Chaîne de format composite.

args
Object[]

Tableau d’objets à mettre en forme.

Retours

Référence à cette instance une fois l’opération d’ajout terminée. Après l’opération d’ajout, cette instance contient toutes les données qui existaient avant l’opération, suffixees par une copie de format où toute spécification de format est remplacée par la représentation sous forme de chaîne de l’argument objet correspondant.

Exceptions

format est null.

format n’est pas valide.

-ou-

L’index d’un élément de format est inférieur à 0 (zéro), ou supérieur ou égal à la longueur du tableau args.

La longueur de la chaîne développée dépasserait MaxCapacity.

Exemples

L’exemple suivant illustre la méthode 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
*/

L’exemple suivant définit une implémentation de IFormatProvider personnalisée nommée CustomerFormatter qui met en forme un numéro client à 10 chiffres avec des traits d’union après les quatrième et septième chiffres. Il est transmis à la méthode StringBuilder.AppendFormat(IFormatProvider, String, Object[]) pour créer une chaîne qui inclut le numéro de client mis en forme et le nom du client.

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

Remarques

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 plusieurs exécutions de texte mélangées avec zéro ou plus d’espaces réservés indexés, appelés éléments de format, qui correspondent aux objets de la liste de paramètres de cette méthode. Le processus de mise en forme remplace chaque élément de format par la représentation sous forme de chaîne de l’objet correspondant.

La syntaxe d’un élément de format est la suivante :

{index[,longueur][ :formatString]}

Les éléments entre crochets sont facultatifs. Le tableau suivant décrit chaque élément.

Élément Description
d’index Position de base zéro dans la liste de paramètres de l’objet à mettre en forme. Si l’objet spécifié par index est null, l’élément de format est remplacé par String.Empty. S’il n’existe aucun paramètre dans l’index position, une FormatException est levée.
,longueur Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre. S’il est positif, le paramètre est aligné à droite ; s’il est négatif, il est aligné à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.

Note

Pour connaître les chaînes de format standard et personnalisées utilisées avec des 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 des valeurs numériques, consultez chaînes de format numérique standard et chaînes de format numérique personnalisées. Pour connaître les chaînes de format standard utilisées avec des énumérations, consultez chaînes de format d’énumération.

Le paramètre provider spécifie une implémentation IFormatProvider qui peut fournir des informations de mise en forme pour les objets dans args. provider peut être l’une des options suivantes :

  • Objet CultureInfo qui fournit des informations de mise en forme spécifiques à la culture.

  • Objet NumberFormatInfo qui fournit des informations de mise en forme spécifiques à la culture pour les valeurs numériques dans args.

  • Objet DateTimeFormatInfo qui fournit des informations de mise en forme propres à la culture pour les valeurs de date et d’heure dans args.

  • Implémentation de IFormatProvider personnalisée qui fournit des informations de mise en forme pour un ou plusieurs des objets dans args. En règle générale, une telle implémentation implémente également l’interface ICustomFormatter. Le deuxième exemple de la section suivante illustre un appel de méthode StringBuilder.AppendFormat(IFormatProvider, String, Object[]) avec une implémentation de IFormatProvider personnalisée.

Si le paramètre provider est null, les informations du fournisseur de format sont obtenues à partir de la culture actuelle.

args représente les objets à mettre en forme. Chaque élément de format de format est remplacé par la représentation sous forme de chaîne de l’objet correspondant dans args. Si l’élément de format inclut formatString et l’objet correspondant dans args implémente l’interface IFormattable, args[index].ToString(formatString, provider) définit la mise en forme. Sinon, args[index].ToString() définit la mise en forme.

Notes pour les appelants

Dans .NET Core et dans .NET Framework 4.0 et versions ultérieures, lorsque vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent dépasser la valeur de sa propriété MaxCapacity. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

.NET 9 et autres versions
Produit Versions
.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

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un seul argument à l’aide d’un fournisseur de format spécifié.

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

Paramètres

provider
IFormatProvider

Objet qui fournit des informations de mise en forme propres à la culture.

format
String

Chaîne de format composite.

arg0
Object

Objet à mettre en forme.

Retours

Référence à cette instance une fois l’opération d’ajout terminée. Après l’opération d’ajout, cette instance contient toutes les données qui existaient avant l’opération, suffixees par une copie de format dans laquelle toute spécification de format est remplacée par la représentation sous forme de chaîne de arg0.

Exceptions

format est null.

format n’est pas valide.

-ou-

L’index d’un élément de format est inférieur à 0 (zéro) ou supérieur ou égal à un (1).

La longueur de la chaîne développée dépasserait MaxCapacity.

Exemples

Voici deux appels à la méthode AppendFormat(IFormatProvider, String, Object). Les deux utilisent les conventions de mise en forme de la culture English-United Kingdom (en-GB). La première insère la représentation sous forme de chaîne d’une devise de valeur Decimal dans une chaîne de résultat. La deuxième insère une valeur DateTime à deux emplacements dans une chaîne de résultat, la première incluant uniquement la chaîne de date courte et la seconde la chaîne de temps courte.

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

Remarques

Cette méthode utilise la fonctionnalité de mise en forme composite du .NET Framework pour convertir la valeur de arg0 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 plusieurs exécutions de texte mélangées avec zéro ou plus d’espaces réservés indexés, appelés éléments de format. L’index de chaque élément de format doit être égal à zéro (0), car cette méthode inclut une liste d’arguments avec un seul argument. Le processus de mise en forme remplace chaque élément de format par la représentation sous forme de chaîne de arg0.

La syntaxe d’un élément de format est la suivante :

{index[,longueur][ :formatString]}

Les éléments entre crochets sont facultatifs. Le tableau suivant décrit chaque élément.

Élément Description
d’index Position de base zéro dans la liste de paramètres de l’objet à mettre en forme. Si l’objet spécifié par index est null, l’élément de format est remplacé par String.Empty. Dans ce cas, étant donné que la méthode AppendFormat(IFormatProvider, String, Object) a un seul argument dans la liste d’arguments, la valeur de index doit toujours être 0. Si ce n’est pas le cas, une FormatException est levée.
,longueur Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre. S’il est positif, le paramètre est aligné à droite ; s’il est négatif, il est aligné à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.

Note

Pour connaître les chaînes de format standard et personnalisées utilisées avec des 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 des valeurs numériques, consultez chaînes de format numérique standard et chaînes de format numérique personnalisées. Pour connaître les chaînes de format standard utilisées avec des énumérations, consultez chaînes de format d’énumération.

Le paramètre provider spécifie une implémentation IFormatProvider qui peut fournir des informations de mise en forme pour les objets dans args. provider peut être l’une des options suivantes :

  • Objet CultureInfo qui fournit des informations de mise en forme spécifiques à la culture.

  • Objet NumberFormatInfo qui fournit des informations de mise en forme propres à la culture pour arg0 s’il s’agit d’une valeur numérique.

  • Objet DateTimeFormatInfo qui fournit des informations de mise en forme propres à la culture pour arg0 s’il s’agit d’une valeur de date et d’heure.

  • Implémentation IFormatProvider personnalisée qui fournit des informations de mise en forme pour arg0. En règle générale, une telle implémentation implémente également l’interface ICustomFormatter.

Si le paramètre provider est null, les informations de mise en forme sont obtenues à partir de la culture actuelle.

arg0 représente l’objet à mettre en forme. Chaque élément de format dans format est remplacé par la représentation sous forme de chaîne de arg0. Si l’élément de format inclut formatString et arg0 implémente l’interface IFormattable, arg0.ToString(formatString, provider) définit la mise en forme. Sinon, arg0.ToString() définit la mise en forme.

Notes pour les appelants

Dans .NET Core et dans .NET Framework 4.0 et versions ultérieures, lorsque vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent dépasser la valeur de sa propriété MaxCapacity. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

.NET 9 et autres versions
Produit Versions
.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

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un argument correspondant dans un tableau de paramètres.

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

Paramètres

format
String

Chaîne de format composite.

args
Object[]

Tableau d’objets à mettre en forme.

Retours

Référence à cette instance avec format ajouté. Chaque élément de format de format est remplacé par la représentation sous forme de chaîne de l’argument objet correspondant.

Exceptions

format ou args est null.

format n’est pas valide.

-ou-

L’index d’un élément de format est inférieur à 0 (zéro), ou supérieur ou égal à la longueur du tableau args.

La longueur de la chaîne développée dépasserait MaxCapacity.

Exemples

L’exemple suivant illustre la méthode 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
*/

Remarques

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 plusieurs exécutions de texte mélangées avec zéro ou plus d’espaces réservés indexés, appelés éléments de format, qui correspondent aux objets de la liste de paramètres de cette méthode. Le processus de mise en forme remplace chaque élément de format par la représentation sous forme de chaîne de l’objet correspondant.

La syntaxe d’un élément de format est la suivante :

{index[,longueur][ :formatString]}

Les éléments entre crochets sont facultatifs. Le tableau suivant décrit chaque élément.

Élément Description
d’index Position de base zéro dans la liste de paramètres de l’objet à mettre en forme. Si l’objet spécifié par index est null, l’élément de format est remplacé par String.Empty. S’il n’existe aucun paramètre dans l’index position, une FormatException est levée.
,longueur Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre. S’il est positif, le paramètre est aligné à droite ; s’il est négatif, il est aligné à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.

Note

Pour connaître les chaînes de format standard et personnalisées utilisées avec des 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 des valeurs numériques, consultez chaînes de format numérique standard et chaînes de format numérique personnalisées. Pour connaître les chaînes de format standard utilisées avec des énumérations, consultez chaînes de format d’énumération.

args représente les objets à mettre en forme. Chaque élément de format de format est remplacé par la représentation sous forme de chaîne de l’objet correspondant dans args. Si l’élément de format inclut formatString et l’objet correspondant dans args implémente l’interface IFormattable, args[index].ToString(formatString, provider) définit la mise en forme. Sinon, args[index].ToString() définit la mise en forme.

Si la chaîne attribuée à format est « Merci pour votre don de {0 :####} cans de nourriture à notre organisation caritative ». Et arg0 est un entier avec la valeur 10, la valeur de retour sera « Merci pour votre don de 10 canons de nourriture à notre organisation caritative ».

Notes pour les appelants

Dans .NET Core et dans .NET Framework 4.0 et versions ultérieures, lorsque vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent dépasser la valeur de sa propriété MaxCapacity. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

.NET 9 et autres versions
Produit Versions
.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

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un seul argument.

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

Paramètres

format
String

Chaîne de format composite.

arg0
Object

Objet à mettre en forme.

Retours

Référence à cette instance avec format ajouté. Chaque élément de format de format est remplacé par la représentation sous forme de chaîne de arg0.

Exceptions

format est null.

format n’est pas valide.

-ou-

L’index d’un élément de format est inférieur à 0 (zéro) ou supérieur ou égal à 1.

La longueur de la chaîne développée dépasserait MaxCapacity.

Exemples

L’exemple suivant illustre la méthode 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
*/

Remarques

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 plusieurs exécutions de texte mélangées avec zéro ou plus d’espaces réservés indexés, appelés éléments de format. L’index des éléments de format doit être 0, pour correspondre à arg0, l’objet unique dans la liste de paramètres de cette méthode. Le processus de mise en forme remplace chaque élément de format par la représentation sous forme de chaîne de arg0.

La syntaxe d’un élément de format est la suivante :

{index[,longueur][ :formatString]}

Les éléments entre crochets sont facultatifs. Le tableau suivant décrit chaque élément.

Élément Description
d’index Position de base zéro dans la liste de paramètres de l’objet à mettre en forme. Si l’objet spécifié par index est null, l’élément de format est remplacé par String.Empty. S’il n’existe aucun paramètre dans l’index position, une FormatException est levée.
,longueur Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre. S’il est positif, le paramètre est aligné à droite ; s’il est négatif, il est aligné à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.

Note

Pour connaître les chaînes de format standard et personnalisées utilisées avec des 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 des valeurs numériques, consultez chaînes de format numérique standard et chaînes de format numérique personnalisées. Pour connaître les chaînes de format standard utilisées avec des énumérations, consultez chaînes de format d’énumération.

arg0 représente l’objet à mettre en forme. Chaque élément de format dans format est remplacé par la représentation sous forme de chaîne de arg0. Si l’élément de format inclut formatString et arg0 implémente l’interface IFormattable, arg0.ToString(formatString, null) définit la mise en forme. Sinon, arg0.ToString() définit la mise en forme.

Si la chaîne attribuée à format est « Merci pour votre don de {0 :####} cans de nourriture à notre organisation caritative ». Et arg0 est un entier avec la valeur 10, la valeur de retour sera « Merci pour votre don de 10 canons de nourriture à notre organisation caritative ».

Notes pour les appelants

Dans .NET Core et dans .NET Framework 4.0 et versions ultérieures, lorsque vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent dépasser la valeur de sa propriété MaxCapacity. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

.NET 9 et autres versions
Produit Versions
.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>)

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un argument correspondant dans une étendue de paramètre à l’aide d’un fournisseur de format spécifié.

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

Paramètres

provider
IFormatProvider

Objet qui fournit des informations de mise en forme propres à la culture.

format
String

Chaîne de format composite.

args
ReadOnlySpan<Object>

Étendue d’objets à mettre en forme.

Retours

Référence à cette instance une fois l’opération d’ajout terminée.

Exceptions

format est null.

La longueur de la chaîne développée dépasserait MaxCapacity.

format n’est pas valide.

-ou-

L’index d’un élément de format est inférieur à 0 (zéro), ou supérieur ou égal à la longueur de l’étendue args.

S’applique à

.NET 9
Produit Versions
.NET 9

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

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des arguments à l’aide d’un fournisseur de format spécifié.

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

Paramètres de type

TArg0

Type du premier objet à mettre en forme.

TArg1

Type du deuxième objet à mettre en forme.

TArg2

Type du troisième objet à mettre en forme.

Paramètres

provider
IFormatProvider

Objet qui fournit des informations de mise en forme propres à la culture.

arg0
TArg0

Premier objet à mettre en forme.

arg1
TArg1

Deuxième objet à mettre en forme.

arg2
TArg2

Troisième objet à mettre en forme.

Retours

Référence à cette instance une fois l’opération d’ajout terminée.

Exceptions

format est null.

L’index d’un élément de format est supérieur ou égal au nombre d’arguments fournis.

S’applique à

.NET 9 et .NET 8
Produit Versions
.NET 8, 9

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

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des arguments à l’aide d’un fournisseur de format spécifié.

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

Paramètres de type

TArg0

Type du premier objet à mettre en forme.

TArg1

Type du deuxième objet à mettre en forme.

Paramètres

provider
IFormatProvider

Objet qui fournit des informations de mise en forme propres à la culture.

arg0
TArg0

Premier objet à mettre en forme.

arg1
TArg1

Deuxième objet à mettre en forme.

Retours

Référence à cette instance une fois l’opération d’ajout terminée.

Exceptions

format est null.

L’index d’un élément de format est supérieur ou égal au nombre d’arguments fournis.

S’applique à

.NET 9 et .NET 8
Produit Versions
.NET 8, 9

AppendFormat<TArg0>(IFormatProvider, CompositeFormat, TArg0)

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Ajoute la chaîne retournée en traitant une chaîne de format composite, qui contient zéro ou plusieurs éléments de format, à cette instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l’un des arguments à l’aide d’un fournisseur de format spécifié.

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

Paramètres de type

TArg0

Type du premier objet à mettre en forme.

Paramètres

provider
IFormatProvider

Objet qui fournit des informations de mise en forme propres à la culture.

arg0
TArg0

Premier objet à mettre en forme.

Retours

Référence à cette instance une fois l’opération d’ajout terminée.

Exceptions

format est null.

L’index d’un élément de format est supérieur ou égal au nombre d’arguments fournis.

S’applique à

.NET 9 et .NET 8
Produit Versions
.NET 8, 9