StringBuilder.AppendFormat Méthode

Définition

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

Surcharges

AppendFormat(String, Object, Object)

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l'un des deux arguments possibles.

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

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de format est remplacé par la représentation sous forme de chaîne d'un argument parmi trois à l'aide d'un fournisseur de format spécifié.

AppendFormat(String, Object, Object, Object)

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l'un des trois arguments possibles.

AppendFormat(IFormatProvider, String, Object, Object)

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un argument parmi deux à l’aide d’un fournisseur de format spécifié.

AppendFormat(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. 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)

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de format est remplacé par la représentation sous forme de chaîne d'un argument unique.

AppendFormat(IFormatProvider, String, Object[])

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de mise en forme 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 à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un argument unique à l’aide d’un fournisseur de format spécifié.

AppendFormat(String, Object[])

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de mise en forme est remplacé par la représentation sous forme de chaîne d'un argument correspondant dans un tableau de paramètres.

AppendFormat(IFormatProvider, CompositeFormat, Object[])

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. 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,TArg2>(IFormatProvider, CompositeFormat, TArg0, TArg1, TArg2)

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. 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 à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. 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 à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. 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)

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

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l'un des deux arguments possibles.

public:
 System::Text::StringBuilder ^ AppendFormat(System::String ^ format, System::Object ^ arg0, System::Object ^ arg1);
public System.Text.StringBuilder AppendFormat (string format, object arg0, object arg1);
public System.Text.StringBuilder AppendFormat (string format, object? arg0, object? arg1);
member this.AppendFormat : string * obj * obj -> System.Text.StringBuilder
Public Function AppendFormat (format As String, arg0 As Object, arg1 As Object) As StringBuilder

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 après l'ajout de format. Chaque élément de mise en forme de format est remplacé par la représentation sous forme de chaîne de l'argument objet correspondant.

Exceptions

format a la valeur 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 AppendFormat méthode.

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

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'X'};
   Console::WriteLine();
   Console::WriteLine( "StringBuilder.AppendFormat method:" );
   sb->AppendFormat( "1) {0}", var1 );
   Show( sb );
   sb->AppendFormat( "2) {0}, {1}", var1, var2 );
   Show( sb );
   sb->AppendFormat( "3) {0}, {1}, {2}", var1, var2, var3 );
   Show( sb );
   sb->AppendFormat( "4) {0}, {1}, {2}", var4 );
   Show( sb );
   CultureInfo^ ci = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   Show( sb );
}

/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
using System;
using System.Text;
using System.Globalization;

class Sample
{
    static StringBuilder sb = new StringBuilder();

    public static void Main()
    {
    int    var1   = 111;
    float  var2   = 2.22F;
    string var3   = "abcd";
    object[] var4 = {3, 4.4, 'X'};

    Console.WriteLine();
    Console.WriteLine("StringBuilder.AppendFormat method:");
    sb.AppendFormat("1) {0}", var1);
    Show(sb);
    sb.AppendFormat("2) {0}, {1}", var1, var2);
    Show(sb);
    sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
    Show(sb);
    sb.AppendFormat("4) {0}, {1}, {2}", var4);
    Show(sb);
    CultureInfo ci = new CultureInfo("es-ES", true);
    sb.AppendFormat(ci, "5) {0}", var2);
    Show(sb);
    }

    public static void Show(StringBuilder sbs)
    {
    Console.WriteLine(sbs.ToString());
    sb.Length = 0;
    }
}
/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
open System.Text
open System.Globalization

let sb = StringBuilder()

let show (sbs: StringBuilder) =
    printfn $"{sbs}"
    sb.Length <- 0

let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]

printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb

// This example produces the following results:
//       StringBuilder.AppendFormat method:
//       1) 111
//       2) 111, 2.22
//       3) 111, 2.22, abcd
//       4) 3, 4.4, X
//       5) 2,22
Imports System.Text
Imports System.Globalization

Class Sample
   Private Shared sb As New StringBuilder()

   Public Shared Sub Main()
      Dim var1 As Integer = 111
      Dim var2 As Single = 2.22F
      Dim var3 As String = "abcd"
      Dim var4 As Object() =  {3, 4.4, "X"c}
      
      Console.WriteLine()
      Console.WriteLine("StringBuilder.AppendFormat method:")
      sb.AppendFormat("1) {0}", var1)
      Show(sb)
      sb.AppendFormat("2) {0}, {1}", var1, var2)
      Show(sb)
      sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
      Show(sb)
      sb.AppendFormat("4) {0}, {1}, {2}", var4)
      Show(sb)
      Dim ci As New CultureInfo("es-ES", True)
      sb.AppendFormat(ci, "5) {0}", var2)
      Show(sb)
   End Sub
   
   Public Shared Sub Show(sbs As StringBuilder)
      Console.WriteLine(sbs.ToString())
      sb.Length = 0
   End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22

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 actuel StringBuilder .

Le format paramètre se compose de zéro ou plusieurs exécutions de texte mélangées avec zéro ou plusieurs espaces réservés indexés, appelés éléments de format, qui correspondent à arg0 et arg1, les deux objets 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 l’objet correspondant.

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

{index[,length][:formatString]}

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

Élément Description
index Position de base zéro dans la liste des 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’y a aucun paramètre dans la position d’index , un 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 ; si elle est négative, elle est alignée à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre .

Notes

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ériques standard et Chaînes de format numériques personnalisées. Pour obtenir 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 format dans format est remplacé par la représentation sous forme de chaîne de arg0 ou 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 affectée à format est « Merci pour votre don de {0:#####} conserves de nourriture à notre organization de bienfaisance » et arg0 est un entier avec la valeur 10, la valeur de retour sera « Merci pour votre don de 10 canettes de nourriture à notre organization de bienfaisance ».

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 StringBuilder(Int32, Int32) constructeur, la longueur et la capacité du StringBuilder instance peuvent dépasser la valeur de sa MaxCapacity propriété. Cela peut se produire en particulier lorsque vous appelez les Append(String) méthodes et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

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

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

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de format est remplacé par la représentation sous forme de chaîne d'un argument parmi trois à l'aide d'un fournisseur de format spécifié.

public:
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::String ^ format, System::Object ^ arg0, System::Object ^ arg1, System::Object ^ arg2);
public System.Text.StringBuilder AppendFormat (IFormatProvider provider, string format, object arg0, object arg1, object arg2);
public System.Text.StringBuilder AppendFormat (IFormatProvider? provider, string format, object? arg0, object? arg1, object? arg2);
member this.AppendFormat : IFormatProvider * string * obj * obj * obj -> System.Text.StringBuilder
Public Function AppendFormat (provider As IFormatProvider, format As String, arg0 As Object, arg1 As Object, arg2 As Object) As StringBuilder

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 après l'opération d'ajout. Après l'opération d'ajout, cette instance contient les données ayant existé avant l'opération, suffixées par une copie de format où la spécification de format est remplacée par la représentation sous forme de chaîne de l'argument d'objet correspondant.

Exceptions

format a la valeur 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 AppendFormat(IFormatProvider, String, Object, Object, Object) méthode pour illustrer le résultat d’une opération booléenne And avec des valeurs entières. Notez que la chaîne de format comprend six éléments de format, mais que la méthode n’a que trois éléments dans sa liste d’arguments, car chaque élément est mis en forme de deux manières différentes.

using System;
using System.Globalization;
using System.Text;

public class Example
{
   public static void Main()
   {
      Random rnd = new Random();
      CultureInfo culture = CultureInfo.CreateSpecificCulture("fr-FR");
      StringBuilder sb = new StringBuilder();
      string formatString = "    {0,12:N0} ({0,8:X8})\n" +
                            "And {1,12:N0} ({1,8:X8})\n" +
                            "  = {2,12:N0} ({2,8:X8})\n";
      for (int ctr = 0; ctr <= 2; ctr++) {
         int value1 = rnd.Next();
         int value2 = rnd.Next();
         sb.AppendFormat(culture, formatString,
                         value1, value2, value1 & value2).
                         AppendLine();
      }
      Console.WriteLine(sb.ToString());
   }
}
// The example displays output like the following:
//           1 984 112 195 (76432643)
//       And 1 179 778 511 (4651FDCF)
//         = 1 178 674 243 (46412443)
//
//           2 034 813 710 (7948CB0E)
//       And  569 333 976 (21EF58D8)
//         =  558 385 160 (21484808)
//
//            126 717 735 (078D8F27)
//       And 1 830 715 973 (6D1E8245)
//         =   84 705 797 (050C8205)
open System
open System.Globalization
open System.Text

let rnd = Random()
let culture = CultureInfo.CreateSpecificCulture "fr-FR"
let sb = StringBuilder()

let formatString =
    "    {0,12:N0} ({0,8:X8})\nAnd {1,12:N0} ({1,8:X8})\n  = {2,12:N0} ({2,8:X8})\n"

for _ = 0 to 2 do
    let value1 = rnd.Next()
    let value2 = rnd.Next()

    sb
        .AppendFormat(culture, formatString, value1, value2, value1 &&& value2)
        .AppendLine()
    |> ignore

printfn $"{sb}"

// The example displays output like the following:
//           1 984 112 195 (76432643)
//       And 1 179 778 511 (4651FDCF)
//         = 1 178 674 243 (46412443)
//
//           2 034 813 710 (7948CB0E)
//       And  569 333 976 (21EF58D8)
//         =  558 385 160 (21484808)
//
//            126 717 735 (078D8F27)
//       And 1 830 715 973 (6D1E8245)
//         =   84 705 797 (050C8205)
Imports System.Globalization
Imports System.Text

Public Module Example
   Public Sub Main()
      Dim rnd As New Random()
      Dim culture As CultureInfo = CultureInfo.CreateSpecificCulture("fr-FR")
      Dim sb As New StringBuilder()
      Dim formatString As String = "    {0,12:N0} ({0,8:X8})" + vbCrLf +
                                   "And {1,12:N0} ({1,8:X8})" + vbCrLf +
                                   "  = {2,12:N0} ({2,8:X8})" + vbCrLf
      For ctr As Integer = 0 To 2
         Dim value1 As Integer = rnd.Next()
         Dim value2 As Integer = rnd.Next()
         sb.AppendFormat(culture, formatString,
                         value1, value2, value1 And value2).AppendLine()
      Next
      Console.WriteLine(sb.ToString())
   End Sub
End Module
' The example displays the following output:
'           1 984 112 195 (76432643)
'       And 1 179 778 511 (4651FDCF)
'         = 1 178 674 243 (46412443)
'
'           2 034 813 710 (7948CB0E)
'       And  569 333 976 (21EF58D8)
'         =  558 385 160 (21484808)
'
'            126 717 735 (078D8F27)
'       And 1 830 715 973 (6D1E8245)
'         =   84 705 797 (050C8205)

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 actuel StringBuilder .

Le format paramètre se compose de zéro ou plusieurs séries de texte mélangées avec zéro ou plusieurs 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[,length][:formatString]}

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

Élément Description
index Position de base zéro dans la liste des 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’y a aucun paramètre dans la position d’index , un 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 ; si elle est négative, elle est alignée à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre .

Notes

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

Le provider paramètre spécifie une IFormatProvider implémentation qui peut fournir des informations de mise en forme pour arg0 et arg1. provider peut être l'une des fonctions 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’il s’agit de valeurs de date et d’heure.

  • Implémentation personnalisée IFormatProvider 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 provider paramètre est null, les informations de 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 de ToString(formatString, provider) l’argument définit la mise en forme. Sinon, la méthode de l’argument 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 StringBuilder(Int32, Int32) constructeur, la longueur et la capacité du StringBuilder instance peuvent dépasser la valeur de sa MaxCapacity propriété. Cela peut se produire en particulier lorsque vous appelez les Append(String) méthodes et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

AppendFormat(String, Object, Object, Object)

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

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l'un des trois arguments possibles.

public:
 System::Text::StringBuilder ^ AppendFormat(System::String ^ format, System::Object ^ arg0, System::Object ^ arg1, System::Object ^ arg2);
public System.Text.StringBuilder AppendFormat (string format, object arg0, object arg1, object arg2);
public System.Text.StringBuilder AppendFormat (string format, object? arg0, object? arg1, object? arg2);
member this.AppendFormat : string * obj * obj * obj -> System.Text.StringBuilder
Public Function AppendFormat (format As String, arg0 As Object, arg1 As Object, arg2 As Object) As StringBuilder

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 après l'ajout de format. Chaque élément de mise en forme de format est remplacé par la représentation sous forme de chaîne de l'argument objet correspondant.

Exceptions

format a la valeur 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 AppendFormat méthode.

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

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'X'};
   Console::WriteLine();
   Console::WriteLine( "StringBuilder.AppendFormat method:" );
   sb->AppendFormat( "1) {0}", var1 );
   Show( sb );
   sb->AppendFormat( "2) {0}, {1}", var1, var2 );
   Show( sb );
   sb->AppendFormat( "3) {0}, {1}, {2}", var1, var2, var3 );
   Show( sb );
   sb->AppendFormat( "4) {0}, {1}, {2}", var4 );
   Show( sb );
   CultureInfo^ ci = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   Show( sb );
}

/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
using System;
using System.Text;
using System.Globalization;

class Sample
{
    static StringBuilder sb = new StringBuilder();

    public static void Main()
    {
    int    var1   = 111;
    float  var2   = 2.22F;
    string var3   = "abcd";
    object[] var4 = {3, 4.4, 'X'};

    Console.WriteLine();
    Console.WriteLine("StringBuilder.AppendFormat method:");
    sb.AppendFormat("1) {0}", var1);
    Show(sb);
    sb.AppendFormat("2) {0}, {1}", var1, var2);
    Show(sb);
    sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
    Show(sb);
    sb.AppendFormat("4) {0}, {1}, {2}", var4);
    Show(sb);
    CultureInfo ci = new CultureInfo("es-ES", true);
    sb.AppendFormat(ci, "5) {0}", var2);
    Show(sb);
    }

    public static void Show(StringBuilder sbs)
    {
    Console.WriteLine(sbs.ToString());
    sb.Length = 0;
    }
}
/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
open System.Text
open System.Globalization

let sb = StringBuilder()

let show (sbs: StringBuilder) =
    printfn $"{sbs}"
    sb.Length <- 0

let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]

printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb

// This example produces the following results:
//       StringBuilder.AppendFormat method:
//       1) 111
//       2) 111, 2.22
//       3) 111, 2.22, abcd
//       4) 3, 4.4, X
//       5) 2,22
Imports System.Text
Imports System.Globalization

Class Sample
   Private Shared sb As New StringBuilder()

   Public Shared Sub Main()
      Dim var1 As Integer = 111
      Dim var2 As Single = 2.22F
      Dim var3 As String = "abcd"
      Dim var4 As Object() =  {3, 4.4, "X"c}
      
      Console.WriteLine()
      Console.WriteLine("StringBuilder.AppendFormat method:")
      sb.AppendFormat("1) {0}", var1)
      Show(sb)
      sb.AppendFormat("2) {0}, {1}", var1, var2)
      Show(sb)
      sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
      Show(sb)
      sb.AppendFormat("4) {0}, {1}, {2}", var4)
      Show(sb)
      Dim ci As New CultureInfo("es-ES", True)
      sb.AppendFormat(ci, "5) {0}", var2)
      Show(sb)
   End Sub
   
   Public Shared Sub Show(sbs As StringBuilder)
      Console.WriteLine(sbs.ToString())
      sb.Length = 0
   End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22

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 actuel StringBuilder .

Le format paramètre se compose de zéro ou plusieurs exécutions de texte mélangées avec zéro ou plusieurs espaces réservés indexés, appelés éléments de format, qui correspondent à arg0 via arg2, les objets 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 l’objet correspondant.

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

{index[,length][:formatString]}

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

Élément Description
index Position de base zéro dans la liste des 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’y a aucun paramètre dans la position d’index , un 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 ; si elle est négative, elle est alignée à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre .

Notes

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 obtenir 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 les é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, arg1ou arg2, en fonction de l’index de l’élément de format. Si l’élément de format inclut formatString et que 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 affectée à format est « Merci pour votre don de {0:####} canons de nourriture à notre organization de bienfaisance » et arg0 est un entier avec la valeur 10, la valeur de retour sera « Merci pour votre don de 10 canons de nourriture à notre organization de bienfaisance ».

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 StringBuilder(Int32, Int32) constructeur, la longueur et la capacité du StringBuilder instance peuvent dépasser la valeur de sa MaxCapacity propriété. Cela peut se produire en particulier lorsque vous appelez les Append(String) méthodes et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

AppendFormat(IFormatProvider, String, Object, Object)

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

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un argument parmi deux à l’aide d’un fournisseur de format spécifié.

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

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 après l'opération d'ajout. Après l'opération d'ajout, cette instance contient les données ayant existé avant l'opération, suffixées par une copie de format où la spécification de format est remplacée par la représentation sous forme de chaîne de l'argument d'objet correspondant.

Exceptions

format a la valeur 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 pour afficher les AppendFormat(IFormatProvider, String, Object, Object) données d’heure et de température stockées dans un objet générique Dictionary<TKey,TValue> . Notez que la chaîne de format a trois éléments de format, bien qu’il n’y ait que des objets à mettre en forme. En effet, le premier objet de la liste (une 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.

using System;
using System.Collections.Generic;
using System.Globalization;
using System.Text;

public class Example
{
   public static void Main()
   {
      CultureInfo culture = new CultureInfo("en-US");
      StringBuilder sb = new StringBuilder();
      Dictionary<DateTime, Double> temperatureInfo = new Dictionary<DateTime, Double>(); 
      temperatureInfo.Add(new DateTime(2010, 6, 1, 14, 0, 0), 87.46);
      temperatureInfo.Add(new DateTime(2010, 12, 1, 10, 0, 0), 36.81);

      sb.AppendLine("Temperature Information:\n");
      foreach (var item in temperatureInfo)
      {
         sb.AppendFormat(culture,
                         "Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F\n",
                         item.Key, item.Value);
      }
      Console.WriteLine(sb.ToString());
   }
}
// The example displays the following output:
//       Temperature Information:
//       
//       Temperature at  2:00 PM on  6/1/2010:  87.5°F
//       Temperature at 10:00 AM on 12/1/2010:  36.8°F
open System
open System.Collections.Generic
open System.Globalization
open System.Text

let culture = CultureInfo "en-US"
let sb = StringBuilder()
let temperatureInfo = Dictionary<DateTime, Double>()
temperatureInfo.Add(DateTime(2010, 6, 1, 14, 0, 0), 87.46)
temperatureInfo.Add(DateTime(2010, 12, 1, 10, 0, 0), 36.81)

sb.AppendLine "Temperature Information:\n" |> ignore

for item in temperatureInfo do
    sb.AppendFormat(culture, "Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F\n", item.Key, item.Value)
    |> ignore

printfn $"{sb}"

// The example displays the following output:
//       Temperature Information:
//
//       Temperature at  2:00 PM on  6/1/2010:  87.5°F
//       Temperature at 10:00 AM on 12/1/2010:  36.8°F
Imports System.Collections.Generic
Imports System.Globalization
Imports System.Text

Module Example
   Public Sub Main()
      Dim culture As New CultureInfo("en-US")
      Dim sb As New StringBuilder()
      Dim temperatureInfo As New Dictionary(Of Date, Double) 
      temperatureInfo.Add(#6/1/2010 2:00PM#, 87.46)
      temperatureInfo.Add(#12/1/2010 10:00AM#, 36.81)
      
      sb.AppendLine("Temperature Information:").AppendLine()
      For Each item In temperatureInfo
         sb.AppendFormat(culture,
                         "Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F",
                         item.Key, item.Value).AppendLine()
      Next
      Console.WriteLine(sb.ToString())
   End Sub
End Module
' The example displays the following output:
'       Temperature Information:
'       
'       Temperature at  2:00 PM on  6/1/2010:  87.5°F
'       Temperature at 10:00 AM on 12/1/2010:  36.8°F

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 actif StringBuilder .

Le format paramètre se compose de zéro ou plusieurs exécutions de texte mélangées avec zéro ou plusieurs 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[,length][:formatString]}

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

Élément Description
index Position de base zéro dans la liste des paramètres de l’objet à mettre en forme. Si l’objet spécifié par l’index est null, l’élément de format est remplacé par String.Empty. S’il n’y a aucun paramètre dans la position d’index , un 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 ; si elle est négative, elle est alignée à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.

Notes

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 obtenir 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 les énumérations, consultez Chaînes de format d’énumération.

Le provider paramètre spécifie une IFormatProvider implémentation qui peut fournir des informations de mise en forme pour arg0 et arg1. provider peut être l'une des fonctions 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’il s’agit de valeurs de date et d’heure.

  • Implémentation personnalisée IFormatProvider 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 provider paramètre est null, les informations de 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 de ToString(formatString, provider) l’argument définit la mise en forme. Sinon, la méthode de ToString() 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 StringBuilder(Int32, Int32) constructeur, la longueur et la capacité du StringBuilder instance peuvent dépasser la valeur de sa MaxCapacity propriété. Cela peut se produire en particulier lorsque vous appelez les Append(String) méthodes et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

AppendFormat(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. 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é.

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

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 après l'opération d'ajout.

Exceptions

format a la valeur null.

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

S’applique à

AppendFormat(String, Object)

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

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de format est remplacé par la représentation sous forme de chaîne d'un argument unique.

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

Paramètres

format
String

Chaîne de format composite.

arg0
Object

Objet à mettre en forme.

Retours

Référence à cette instance après l'ajout de format. Chaque élément de mise en forme dans format est remplacé par la représentation sous forme de chaîne de arg0.

Exceptions

format a la valeur 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 AppendFormat méthode.

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

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'X'};
   Console::WriteLine();
   Console::WriteLine( "StringBuilder.AppendFormat method:" );
   sb->AppendFormat( "1) {0}", var1 );
   Show( sb );
   sb->AppendFormat( "2) {0}, {1}", var1, var2 );
   Show( sb );
   sb->AppendFormat( "3) {0}, {1}, {2}", var1, var2, var3 );
   Show( sb );
   sb->AppendFormat( "4) {0}, {1}, {2}", var4 );
   Show( sb );
   CultureInfo^ ci = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   Show( sb );
}

/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
using System;
using System.Text;
using System.Globalization;

class Sample
{
    static StringBuilder sb = new StringBuilder();

    public static void Main()
    {
    int    var1   = 111;
    float  var2   = 2.22F;
    string var3   = "abcd";
    object[] var4 = {3, 4.4, 'X'};

    Console.WriteLine();
    Console.WriteLine("StringBuilder.AppendFormat method:");
    sb.AppendFormat("1) {0}", var1);
    Show(sb);
    sb.AppendFormat("2) {0}, {1}", var1, var2);
    Show(sb);
    sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
    Show(sb);
    sb.AppendFormat("4) {0}, {1}, {2}", var4);
    Show(sb);
    CultureInfo ci = new CultureInfo("es-ES", true);
    sb.AppendFormat(ci, "5) {0}", var2);
    Show(sb);
    }

    public static void Show(StringBuilder sbs)
    {
    Console.WriteLine(sbs.ToString());
    sb.Length = 0;
    }
}
/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
open System.Text
open System.Globalization

let sb = StringBuilder()

let show (sbs: StringBuilder) =
    printfn $"{sbs}"
    sb.Length <- 0

let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]

printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb

// This example produces the following results:
//       StringBuilder.AppendFormat method:
//       1) 111
//       2) 111, 2.22
//       3) 111, 2.22, abcd
//       4) 3, 4.4, X
//       5) 2,22
Imports System.Text
Imports System.Globalization

Class Sample
   Private Shared sb As New StringBuilder()

   Public Shared Sub Main()
      Dim var1 As Integer = 111
      Dim var2 As Single = 2.22F
      Dim var3 As String = "abcd"
      Dim var4 As Object() =  {3, 4.4, "X"c}
      
      Console.WriteLine()
      Console.WriteLine("StringBuilder.AppendFormat method:")
      sb.AppendFormat("1) {0}", var1)
      Show(sb)
      sb.AppendFormat("2) {0}, {1}", var1, var2)
      Show(sb)
      sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
      Show(sb)
      sb.AppendFormat("4) {0}, {1}, {2}", var4)
      Show(sb)
      Dim ci As New CultureInfo("es-ES", True)
      sb.AppendFormat(ci, "5) {0}", var2)
      Show(sb)
   End Sub
   
   Public Shared Sub Show(sbs As StringBuilder)
      Console.WriteLine(sbs.ToString())
      sb.Length = 0
   End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22

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 actif StringBuilder .

Le format paramètre se compose de zéro ou plusieurs exécutions de texte mélangées à un ou plusieurs 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 des 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[,length][:formatString]}

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

Élément Description
index Position de base zéro dans la liste des paramètres de l’objet à mettre en forme. Si l’objet spécifié par l’index est null, l’élément de format est remplacé par String.Empty. S’il n’y a aucun paramètre dans la position d’index , un 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 ; si elle est négative, elle est alignée à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.

Notes

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 obtenir 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 les é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 affectée à format est « Merci pour votre don de {0:####} canons de nourriture à notre organization de bienfaisance » et arg0 est un entier avec la valeur 10, la valeur de retour sera « Merci pour votre don de 10 canons de nourriture à notre organization de bienfaisance ».

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 StringBuilder(Int32, Int32) constructeur, la longueur et la capacité de l’instance StringBuilder peuvent dépasser la valeur de sa MaxCapacity propriété. Cela peut se produire en particulier lorsque vous appelez les Append(String) méthodes et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

AppendFormat(IFormatProvider, String, Object[])

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

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de mise en forme 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é.

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

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 après l'opération d'ajout. Après l'opération d'ajout, cette instance contient les données ayant existé avant l'opération, suffixées par une copie de format où la spécification de format est remplacée par la représentation sous forme de chaîne de l'argument d'objet correspondant.

Exceptions

format a la valeur 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 AppendFormat méthode.

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

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'X'};
   Console::WriteLine();
   Console::WriteLine( "StringBuilder.AppendFormat method:" );
   sb->AppendFormat( "1) {0}", var1 );
   Show( sb );
   sb->AppendFormat( "2) {0}, {1}", var1, var2 );
   Show( sb );
   sb->AppendFormat( "3) {0}, {1}, {2}", var1, var2, var3 );
   Show( sb );
   sb->AppendFormat( "4) {0}, {1}, {2}", var4 );
   Show( sb );
   CultureInfo^ ci = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   Show( sb );
}

/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
using System;
using System.Text;
using System.Globalization;

class Sample
{
    static StringBuilder sb = new StringBuilder();

    public static void Main()
    {
    int    var1   = 111;
    float  var2   = 2.22F;
    string var3   = "abcd";
    object[] var4 = {3, 4.4, 'X'};

    Console.WriteLine();
    Console.WriteLine("StringBuilder.AppendFormat method:");
    sb.AppendFormat("1) {0}", var1);
    Show(sb);
    sb.AppendFormat("2) {0}, {1}", var1, var2);
    Show(sb);
    sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
    Show(sb);
    sb.AppendFormat("4) {0}, {1}, {2}", var4);
    Show(sb);
    CultureInfo ci = new CultureInfo("es-ES", true);
    sb.AppendFormat(ci, "5) {0}", var2);
    Show(sb);
    }

    public static void Show(StringBuilder sbs)
    {
    Console.WriteLine(sbs.ToString());
    sb.Length = 0;
    }
}
/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
open System.Text
open System.Globalization

let sb = StringBuilder()

let show (sbs: StringBuilder) =
    printfn $"{sbs}"
    sb.Length <- 0

let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]

printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb

// This example produces the following results:
//       StringBuilder.AppendFormat method:
//       1) 111
//       2) 111, 2.22
//       3) 111, 2.22, abcd
//       4) 3, 4.4, X
//       5) 2,22
Imports System.Text
Imports System.Globalization

Class Sample
   Private Shared sb As New StringBuilder()

   Public Shared Sub Main()
      Dim var1 As Integer = 111
      Dim var2 As Single = 2.22F
      Dim var3 As String = "abcd"
      Dim var4 As Object() =  {3, 4.4, "X"c}
      
      Console.WriteLine()
      Console.WriteLine("StringBuilder.AppendFormat method:")
      sb.AppendFormat("1) {0}", var1)
      Show(sb)
      sb.AppendFormat("2) {0}, {1}", var1, var2)
      Show(sb)
      sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
      Show(sb)
      sb.AppendFormat("4) {0}, {1}, {2}", var4)
      Show(sb)
      Dim ci As New CultureInfo("es-ES", True)
      sb.AppendFormat(ci, "5) {0}", var2)
      Show(sb)
   End Sub
   
   Public Shared Sub Show(sbs As StringBuilder)
      Console.WriteLine(sbs.ToString())
      sb.Length = 0
   End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22

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

using System;
using System.Text;

public class Customer
{
   private string custName;
   private int custNumber;
   
   public Customer(string name, int number)
   {
      this.custName = name;
      this.custNumber = number;
   }
   
   public string Name
   {
      get { return this.custName; }
   }
   
   public int CustomerNumber
   {
      get { return this.custNumber; }
   }
}

public class CustomerNumberFormatter : IFormatProvider, ICustomFormatter
{   
   public object GetFormat(Type formatType)
   {
      if (formatType == typeof(ICustomFormatter))
         return this;
      return null;
   }
   
   public string Format(string format, object arg, IFormatProvider provider)
   {
      if (arg is Int32)
      {
         string custNumber = ((int) arg).ToString("D10");
         return custNumber.Substring(0, 4) + "-" + custNumber.Substring(4, 3) + 
                "-" + custNumber.Substring(7, 3);
      }
      else
      {
         return null;
      }
   }                   
}

public class Example
{
   public static void Main()
   {
      Customer customer = new Customer("A Plus Software", 903654);
      StringBuilder sb = new StringBuilder();
      sb.AppendFormat(new CustomerNumberFormatter(), "{0}: {1}", 
                      customer.CustomerNumber, customer.Name);
      Console.WriteLine(sb.ToString());
   }
}
// The example displays the following output:
//      0000-903-654: A Plus Software
open System
open System.Text

type Customer(name: string, number: int) =
    member _.Name = name
    member _.CustomerNumber = number

type CustomerNumberFormatter() =
    interface IFormatProvider with
        member this.GetFormat(formatType) =
            if formatType = typeof<ICustomFormatter> then this else null

    interface ICustomFormatter with
        member _.Format(_, arg, _) =
            match arg with
            | :? int as i ->
                let custNumber = i.ToString "D10"
                $"{custNumber.Substring(0, 4)}-{custNumber.Substring(4, 3)}-{custNumber.Substring(7, 3)}"
            | _ -> null

let customer = Customer("A Plus Software", 903654)
let sb = StringBuilder()

sb.AppendFormat(CustomerNumberFormatter(), "{0}: {1}", customer.CustomerNumber, customer.Name)
|> ignore

printfn $"{sb}"

// The example displays the following output:
//      0000-903-654: A Plus Software
Imports System.Text

Public Class Customer
   Private custName As String
   Private custNumber As Integer
   
   Public Sub New(name As String, number As Integer)
      custName = name
      custNumber = number
   End Sub
   
   Public ReadOnly Property Name As String
      Get
         Return Me.custName
      End Get
   End Property
   
   Public ReadOnly Property CustomerNumber As Integer
      Get
         Return Me.custNumber
      End Get
   End Property
End Class

Public Class CustomerNumberFormatter 
   Implements IFormatProvider, ICustomFormatter
   
   Public Function GetFormat(formatType As Type) As Object _
                   Implements IFormatProvider.GetFormat
      If formatType Is GetType(ICustomFormatter) Then
         Return Me
      End If
      Return Nothing
   End Function
   
   Public Function Format(fmt As String, arg As Object, provider As IFormatProvider) As String _
                   Implements ICustomFormatter.Format
      If typeof arg Is Int32 Then
         Dim custNumber As String = CInt(arg).ToString("D10")
         Return custNumber.Substring(0, 4) + "-" + custNumber.SubString(4, 3) + _
                "-" + custNumber.Substring(7, 3)
      Else
         Return Nothing
      End If
   End Function                   
End Class

Module Example
   Public Sub Main()
      Dim customer As New Customer("A Plus Software", 903654)
      Dim sb As New StringBuilder()
      sb.AppendFormat(New CustomerNumberFormatter, "{0}: {1}", _
                      customer.CustomerNumber, customer.Name)
      Console.WriteLine(sb.ToString())
   End Sub
End Module
' The example displays the following output:
'      0000-903-654: A Plus Software

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 actif StringBuilder .

Le format paramètre se compose de zéro ou plusieurs exécutions de texte mélangées avec zéro ou plusieurs 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[,length][:formatString]}

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

Élément Description
index Position de base zéro dans la liste des paramètres de l’objet à mettre en forme. Si l’objet spécifié par l’index est null, l’élément de format est remplacé par String.Empty. S’il n’y a aucun paramètre dans la position d’index , un 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 ; si elle est négative, elle est alignée à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.

Notes

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 obtenir 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 les énumérations, consultez Chaînes de format d’énumération.

Le provider paramètre spécifie une IFormatProvider implémentation qui peut fournir des informations de mise en forme pour les objets dans args. provider peut être l'une des fonctions 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 spécifiques à la culture pour les valeurs de date et d’heure dans args.

  • Implémentation personnalisée IFormatProvider qui fournit des informations de mise en forme pour un ou plusieurs 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 StringBuilder.AppendFormat(IFormatProvider, String, Object[]) méthode avec une implémentation personnalisée IFormatProvider .

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

args représente 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 correspondant dans args. Si l’élément de format inclut formatString et que 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 StringBuilder(Int32, Int32) constructeur, la longueur et la capacité de l’instance StringBuilder peuvent dépasser la valeur de sa MaxCapacity propriété. Cela peut se produire en particulier lorsque vous appelez les Append(String) méthodes et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

AppendFormat(IFormatProvider, String, Object)

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

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de format est remplacé par la représentation sous forme de chaîne d’un argument unique à l’aide d’un fournisseur de format spécifié.

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

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 après l'opération d'ajout. Après l'opération d'ajout, cette instance contient les données qui existaient avant l'opération, avec comme suffixe 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 a la valeur 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 (un).

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

Exemples

Les éléments suivants incluent deux appels à la AppendFormat(IFormatProvider, String, Object) méthode . Les deux utilisent les conventions de mise en forme de la culture English-United Kingdom (en-GB). Le premier insère la représentation sous forme de chaîne d’une Decimal devise de valeur dans une chaîne de résultat. Le second insère une DateTime valeur à deux emplacements dans une chaîne de résultat, le premier incluant uniquement la chaîne de date courte et le second la chaîne de temps court.

using System;
using System.Globalization;
using System.Text;

public class Example
{
   public static void Main()
   {
      StringBuilder sb = new StringBuilder();
      Decimal value = 16.95m;
      CultureInfo enGB = CultureInfo.CreateSpecificCulture("en-GB");
      DateTime dateToday = DateTime.Now;
      sb.AppendFormat(enGB, "Final Price: {0:C2}", value);
      sb.AppendLine();
      sb.AppendFormat(enGB, "Date and Time: {0:d} at {0:t}", dateToday);
      Console.WriteLine(sb.ToString());
   }
}
// The example displays the following output:
//       Final Price: £16.95
//       Date and Time: 01/10/2014 at 10:22
open System
open System.Globalization
open System.Text

let sb = StringBuilder()
let value = 16.95m
let enGB = CultureInfo.CreateSpecificCulture "en-GB"
let dateToday = DateTime.Now
sb.AppendFormat(enGB, "Final Price: {0:C2}", value) |> ignore
sb.AppendLine() |> ignore
sb.AppendFormat(enGB, "Date and Time: {0:d} at {0:t}", dateToday) |> ignore
printfn $"{sb}"

// The example displays the following output:
//       Final Price: £16.95
//       Date and Time: 01/10/2014 at 10:22
Imports System.Globalization
Imports System.Text

Module Example
   Public Sub Main()
      Dim sb As New StringBuilder()
      Dim value As Decimal = 16.95d
      Dim enGB As CultureInfo = CultureInfo.CreateSpecificCulture("en-GB")
      Dim dateToday As DateTime = Date.Now
      sb.AppendFormat(enGB, "Final Price: {0:C2}", value)
      sb.AppendLine()
      sb.AppendFormat(enGB, "Date and Time: {0:d} at {0:t}", dateToday)
      Console.WriteLine(sb.ToString())
   End Sub
End Module
' The example displays output like the following:
'       Final Price: £16.95
'       Date and Time: 01/10/2014 at 10:22

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 actif StringBuilder .

Le format paramètre se compose de zéro ou plusieurs exécutions de texte mélangées à un ou plusieurs 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 argument unique. 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[,length][:formatString]}

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

Élément Description
index Position de base zéro dans la liste des paramètres de l’objet à mettre en forme. Si l’objet spécifié par l’index est null, l’élément de format est remplacé par String.Empty. Dans ce cas, étant donné que la AppendFormat(IFormatProvider, String, Object) méthode a un seul argument dans la liste d’arguments, la valeur de l’index doit toujours être 0. Si ce n’est pas le cas, un 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 ; si elle est négative, elle est alignée à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.

Notes

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 obtenir 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 les énumérations, consultez Chaînes de format d’énumération.

Le provider paramètre spécifie une IFormatProvider implémentation qui peut fournir des informations de mise en forme pour les objets dans args. provider peut être l'une des fonctions 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 s’il s’agit d’une valeur numérique.

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

  • Implémentation personnalisée IFormatProvider 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 provider paramètre 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 StringBuilder(Int32, Int32) constructeur, la longueur et la capacité de l’instance StringBuilder peuvent dépasser la valeur de sa MaxCapacity propriété. Cela peut se produire en particulier lorsque vous appelez les Append(String) méthodes et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

AppendFormat(String, Object[])

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

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. Chaque élément de mise en forme est remplacé par la représentation sous forme de chaîne d'un argument correspondant dans un tableau de paramètres.

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

Paramètres

format
String

Chaîne de format composite.

args
Object[]

Tableau d'objets à mettre en forme.

Retours

Référence à cette instance après l'ajout de format. Chaque élément de mise en forme 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 AppendFormat méthode.

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

int main()
{
   StringBuilder^ sb = gcnew StringBuilder;
   int var1 = 111;
   float var2 = 2.22F;
   String^ var3 = "abcd";
   array<Object^>^var4 = {3,4.4,(Char)'X'};
   Console::WriteLine();
   Console::WriteLine( "StringBuilder.AppendFormat method:" );
   sb->AppendFormat( "1) {0}", var1 );
   Show( sb );
   sb->AppendFormat( "2) {0}, {1}", var1, var2 );
   Show( sb );
   sb->AppendFormat( "3) {0}, {1}, {2}", var1, var2, var3 );
   Show( sb );
   sb->AppendFormat( "4) {0}, {1}, {2}", var4 );
   Show( sb );
   CultureInfo^ ci = gcnew CultureInfo( "es-ES",true );
   array<Object^>^temp1 = {var2};
   sb->AppendFormat( ci, "5) {0}", temp1 );
   Show( sb );
}

/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
using System;
using System.Text;
using System.Globalization;

class Sample
{
    static StringBuilder sb = new StringBuilder();

    public static void Main()
    {
    int    var1   = 111;
    float  var2   = 2.22F;
    string var3   = "abcd";
    object[] var4 = {3, 4.4, 'X'};

    Console.WriteLine();
    Console.WriteLine("StringBuilder.AppendFormat method:");
    sb.AppendFormat("1) {0}", var1);
    Show(sb);
    sb.AppendFormat("2) {0}, {1}", var1, var2);
    Show(sb);
    sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3);
    Show(sb);
    sb.AppendFormat("4) {0}, {1}, {2}", var4);
    Show(sb);
    CultureInfo ci = new CultureInfo("es-ES", true);
    sb.AppendFormat(ci, "5) {0}", var2);
    Show(sb);
    }

    public static void Show(StringBuilder sbs)
    {
    Console.WriteLine(sbs.ToString());
    sb.Length = 0;
    }
}
/*
This example produces the following results:

StringBuilder.AppendFormat method:
1) 111
2) 111, 2.22
3) 111, 2.22, abcd
4) 3, 4.4, X
5) 2,22
*/
open System.Text
open System.Globalization

let sb = StringBuilder()

let show (sbs: StringBuilder) =
    printfn $"{sbs}"
    sb.Length <- 0

let var1 = 111
let var2 = 2.22f
let var3 = "abcd"
let var4: obj[] = [| 3; 4.4; 'X' |]

printfn "StringBuilder.AppendFormat method:"
sb.AppendFormat("1) {0}", var1) |> ignore
show sb
sb.AppendFormat("2) {0}, {1}", var1, var2) |> ignore
show sb
sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3) |> ignore
show sb
sb.AppendFormat("4) {0}, {1}, {2}", var4) |> ignore
show sb
let ci = CultureInfo("es-ES", true)
sb.AppendFormat(ci, "5) {0}", var2) |> ignore
show sb

// This example produces the following results:
//       StringBuilder.AppendFormat method:
//       1) 111
//       2) 111, 2.22
//       3) 111, 2.22, abcd
//       4) 3, 4.4, X
//       5) 2,22
Imports System.Text
Imports System.Globalization

Class Sample
   Private Shared sb As New StringBuilder()

   Public Shared Sub Main()
      Dim var1 As Integer = 111
      Dim var2 As Single = 2.22F
      Dim var3 As String = "abcd"
      Dim var4 As Object() =  {3, 4.4, "X"c}
      
      Console.WriteLine()
      Console.WriteLine("StringBuilder.AppendFormat method:")
      sb.AppendFormat("1) {0}", var1)
      Show(sb)
      sb.AppendFormat("2) {0}, {1}", var1, var2)
      Show(sb)
      sb.AppendFormat("3) {0}, {1}, {2}", var1, var2, var3)
      Show(sb)
      sb.AppendFormat("4) {0}, {1}, {2}", var4)
      Show(sb)
      Dim ci As New CultureInfo("es-ES", True)
      sb.AppendFormat(ci, "5) {0}", var2)
      Show(sb)
   End Sub
   
   Public Shared Sub Show(sbs As StringBuilder)
      Console.WriteLine(sbs.ToString())
      sb.Length = 0
   End Sub
End Class
'
'This example produces the following results:
'
'StringBuilder.AppendFormat method:
'1) 111
'2) 111, 2.22
'3) 111, 2.22, abcd
'4) 3, 4.4, X
'5) 2,22

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 actif StringBuilder .

Le format paramètre se compose de zéro ou plusieurs exécutions de texte mélangées avec zéro ou plusieurs 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[,length][:formatString]}

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

Élément Description
index Position de base zéro dans la liste des paramètres de l’objet à mettre en forme. Si l’objet spécifié par l’index est null, l’élément de format est remplacé par String.Empty. S’il n’y a aucun paramètre dans la position d’index , un 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 ; si elle est négative, elle est alignée à gauche.
:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.

Notes

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 obtenir 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 les énumérations, consultez Chaînes de format d’énumération.

args représente 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 correspondant dans args. Si l’élément de format inclut formatString et que 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 affectée à format est « Merci pour votre don de {0:####} canons de nourriture à notre organization de bienfaisance » et arg0 est un entier avec la valeur 10, la valeur de retour sera « Merci pour votre don de 10 canons de nourriture à notre organization de bienfaisance ».

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 StringBuilder(Int32, Int32) constructeur, la longueur et la capacité de l’instance StringBuilder peuvent dépasser la valeur de sa MaxCapacity propriété. Cela peut se produire en particulier lorsque vous appelez les Append(String) méthodes et AppendFormat(String, Object) pour ajouter de petites chaînes.

Voir aussi

S’applique à

AppendFormat(IFormatProvider, CompositeFormat, Object[])

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. 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é.

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

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 après l'opération d'ajout.

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 à

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

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. 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é.

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

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 après l'opération d'ajout.

Exceptions

format a la valeur null.

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

S’applique à

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

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. 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é.

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

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 après l'opération d'ajout.

Exceptions

format a la valeur null.

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

S’applique à

AppendFormat<TArg0>(IFormatProvider, CompositeFormat, TArg0)

Source:
StringBuilder.cs
Source:
StringBuilder.cs

Ajoute à cette instance la chaîne retournée par le traitement d'une chaîne de format composite, qui contient un nombre supérieur ou égal à zéro d'éléments de mise en forme. 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é.

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

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 après l'opération d'ajout.

Exceptions

format a la valeur null.

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

S’applique à