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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. Chaque élément de mise en forme est remplacé par la représentation sous forme de chaîne d’un argument d’objet correspondant.Each format item is replaced by the string representation of a corresponding object argument.

Surcharges

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 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é.Each format item is replaced by the string representation of either of three arguments using a specified format provider.

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d'un argument unique.Each format item is replaced by the string representation of a single argument.

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 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.Each format item is replaced by the string representation of a corresponding argument in a parameter array.

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 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é.Each format item is replaced by the string representation of a single argument using a specified format provider.

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 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é.Each format item is replaced by the string representation of a corresponding argument in a parameter array using a specified format provider.

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l'un des deux arguments possibles.Each format item is replaced by the string representation of either of two arguments.

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 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é.Each format item is replaced by the string representation of either of two arguments using a specified format provider.

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l'un des trois arguments possibles.Each format item is replaced by the string representation of either of three arguments.

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 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é.Each format item is replaced by the string representation of either of three arguments using a specified format provider.

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);
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.An object that supplies culture-specific formatting information.

format
String

Chaîne de format composite.A composite format string.

arg0
Object

Premier objet à mettre en forme.The first object to format.

arg1
Object

Deuxième objet à mettre en forme.The second object to format.

arg2
Object

Troisième objet à mettre en forme.The third object to format.

Retours

Référence à cette instance après l'opération d'ajout.A reference to this instance after the append operation has completed. 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.After the append operation, this instance contains any data that existed before the operation, suffixed by a copy of format where any format specification is replaced by the string representation of the corresponding object argument.

Exceptions

format a la valeur null.format is null.

format n'est pas valide.format is invalid.

- ou --or-

L’index d’un élément de format est inférieur à 0 (zéro), ou supérieur ou égal à 3 (trois).The index of a format item is less than 0 (zero), or greater than or equal to 3 (three).

La longueur de la chaîne développée dépasserait MaxCapacity.The length of the expanded string would exceed MaxCapacity.

Exemples

L’exemple suivant utilise la méthode AppendFormat(IFormatProvider, String, Object, Object, Object) pour illustrer le résultat d’une opération booléenne And avec des valeurs entières.The following example uses the AppendFormat(IFormatProvider, String, Object, Object, Object) method to illustrate the result of a Boolean And operation with integer values. Notez que la chaîne de format inclut six éléments de mise en forme, mais que la méthode a seulement trois éléments dans sa liste d’arguments, car chaque élément est mis en forme de deux manières différentes.Note that the format string includes six format items, but the method has only three items in its argument list, because each item is formatted in two different ways.

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)
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 StringBuilder actuel.This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

Le paramètre format se compose de zéro, une ou plusieurs exécutions de texte mélangées à zéro, un 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.The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to objects in the parameter list of this method. 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.The formatting process replaces each format item with the string representation of the corresponding object.

La syntaxe d’un élément de format est la suivante :The syntax of a format item is as follows:

{index[,longueur] [ :FormatString]}{index[,length][:formatString]}

Les éléments entre crochets sont facultatifs.Elements in square brackets are optional. Le tableau suivant décrit chaque élément.The following table describes each element.

ÉlémentElement DescriptionDescription
indexindex Position de base zéro dans la liste de paramètres de l’objet à mettre en forme.The zero-based position in the parameter list of the object to be formatted. Si l’objet spécifié par l' index est null, l’élément de mise en forme est remplacé par String.Empty.If the object specified by index is null, the format item is replaced by String.Empty. S’il n’y a aucun paramètre dans la position d' index , une FormatException est levée.If there is no parameter in the index position, a FormatException is thrown.
,length,length Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre.The minimum number of characters in the string representation of the parameter. Si la condition est positive, le paramètre est aligné à droite ; Si la valeur est négative, elle est alignée à gauche.If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.A standard or custom format string that is supported by the parameter.

Notes

Pour les chaînes de format standard et personnalisées utilisées avec les valeurs de date et d’heure, consultez chaînes de format de date et d' heure standard et chaînes de format de date et d’heure personnalisées.For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. Pour 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.For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. Pour les chaînes de format standard utilisées avec les énumérations, consultez chaînes de format d’énumération.For the standard format strings used with enumerations, see Enumeration Format Strings.

Le paramètre provider spécifie une implémentation IFormatProvider qui peut fournir des informations de mise en forme pour arg0 et arg1.The provider parameter specifies an IFormatProvider implementation that can provide formatting information for arg0 and arg1. provider peut être l'une des fonctions suivantes :provider can be any of the following:

  • Objet CultureInfo qui fournit des informations de mise en forme propres à la culture.A CultureInfo object that provides culture-specific formatting information.

  • Objet NumberFormatInfo qui fournit des informations de mise en forme propres à la culture pour arg0 ou arg1 s’il s’agit de valeurs numériques.A NumberFormatInfo object that provides culture-specific formatting information for arg0 or arg1 if they are numeric values.

  • Objet DateTimeFormatInfo qui fournit des informations de mise en forme propres à la culture pour arg0, arg1ou arg2 s’il s’agit de valeurs de date et d’heure.A DateTimeFormatInfo object that provides culture-specific formatting information for arg0, arg1, or arg2 if they are date and time values.

  • Implémentation de IFormatProvider personnalisée qui fournit des informations de mise en forme pour arg0, arg1et arg2.A custom IFormatProvider implementation that provides formatting information for arg0, arg1, and arg2. En règle générale, une telle implémentation implémente également l’interface ICustomFormatter.Typically, such an implementation also implements the ICustomFormatter interface.

Si le paramètre provider est null, les informations de fournisseur de format sont obtenues à partir de la culture actuelle.If the provider parameter is null, format provider information is obtained from the current culture.

arg0, arg1et arg2 représentent les objets à mettre en forme.arg0, arg1, and arg2 represent the objects to be formatted. Chaque élément de mise en forme dans format est remplacé par la représentation sous forme de chaîne de l’objet qui a l’index correspondant.Each format item in format is replaced with the string representation of the object that has the corresponding index. Si l’élément de mise en forme comprend des 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.If the format item includes formatString and the corresponding argument implements the IFormattable interface, then the argument's ToString(formatString, provider) method defines the formatting. Sinon, la méthode ToString() de l’argument définit la mise en forme.Otherwise, the argument's ToString() method defines the formatting.

Notes pour les appelants

Dans .NET Core et dans le .NET Framework 4,0 et versions ultérieures, quand vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent croître au-delà de la valeur de sa propriété MaxCapacity.In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter des chaînes de petite taille.This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

Voir aussi

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne d'un argument unique.Each format item is replaced by the string representation of a single argument.

public:
 System::Text::StringBuilder ^ AppendFormat(System::String ^ format, System::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.A composite format string.

arg0
Object

Objet à mettre en forme.An object to format.

Retours

Référence à cette instance après l'ajout de format.A reference to this instance with format appended. Chaque élément de mise en forme dans format est remplacé par la représentation sous forme de chaîne de arg0.Each format item in format is replaced by the string representation of arg0.

Exceptions

format est null.format is null.

format n'est pas valide.format is invalid.

- ou --or-

L’index d’un élément de format est inférieur à 0 (zéro), ou supérieur ou égal à 1.The index of a format item is less than 0 (zero), or greater than or equal to 1.

La longueur de la chaîne développée dépasserait MaxCapacity.The length of the expanded string would exceed MaxCapacity.

Exemples

L’exemple suivant illustre la méthode AppendFormat.The following example demonstrates the AppendFormat method.

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
*/
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 StringBuilder actuel.This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

Le paramètre format se compose de zéro, une ou plusieurs exécutions de texte mélangées à zéro, un ou plusieurs espaces réservés indexés, appelés éléments de format.The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items. L’index des éléments de mise en forme doit être égal à 0 pour correspondre à arg0, l’objet unique dans la liste de paramètres de cette méthode.The index of the format items must be 0, to correspond to arg0, the single object in the parameter list of this method. Le processus de mise en forme remplace chaque élément de format par la représentation sous forme de chaîne de arg0.The formatting process replaces each format item with the string representation of arg0.

La syntaxe d’un élément de format est la suivante :The syntax of a format item is as follows:

{index[,longueur] [ :FormatString]}{index[,length][:formatString]}

Les éléments entre crochets sont facultatifs.Elements in square brackets are optional. Le tableau suivant décrit chaque élément.The following table describes each element.

ÉlémentElement DescriptionDescription
indexindex Position de base zéro dans la liste de paramètres de l’objet à mettre en forme.The zero-based position in the parameter list of the object to be formatted. Si l’objet spécifié par l' index est null, l’élément de mise en forme est remplacé par String.Empty.If the object specified by index is null, the format item is replaced by String.Empty. S’il n’y a aucun paramètre dans la position d' index , une FormatException est levée.If there is no parameter in the index position, a FormatException is thrown.
,length,length Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre.The minimum number of characters in the string representation of the parameter. Si la condition est positive, le paramètre est aligné à droite ; Si la valeur est négative, elle est alignée à gauche.If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.A standard or custom format string that is supported by the parameter.

Notes

Pour les chaînes de format standard et personnalisées utilisées avec les valeurs de date et d’heure, consultez chaînes de format de date et d' heure standard et chaînes de format de date et d’heure personnalisées.For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. Pour 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.For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. Pour les chaînes de format standard utilisées avec les énumérations, consultez chaînes de format d’énumération.For the standard format strings used with enumerations, see Enumeration Format Strings.

arg0 représente l’objet à mettre en forme.arg0 represents the object to be formatted. Chaque élément de mise en forme dans format est remplacé par la représentation sous forme de chaîne de arg0.Each format item in format is replaced with the string representation of arg0. Si l’élément de mise en forme comprend formatString et arg0 implémente l’interface IFormattable, arg0.ToString(formatString, null) définit la mise en forme.If the format item includes formatString and arg0 implements the IFormattable interface, then arg0.ToString(formatString, null) defines the formatting. Dans le cas contraire, arg0.ToString() définit la mise en forme.Otherwise, arg0.ToString() defines the formatting.

Si la chaîne assignée à format est « Merci pour votre don de {0 : # # # #} boîtes de nourriture à notre organisation charitable ».If the string assigned to format is "Thank you for your donation of {0:####} cans of food to our charitable organization." et arg0 est un entier ayant la valeur 10, la valeur de retour est « Merci pour votre don de 10 boîtes de nourriture à notre organisation charitable ».and arg0 is an integer with the value 10, the return value will be "Thank you for your donation of 10 cans of food to our charitable organization."

Notes pour les appelants

Dans .NET Core et dans le .NET Framework 4,0 et versions ultérieures, quand vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent croître au-delà de la valeur de sa propriété MaxCapacity.In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter des chaînes de petite taille.This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

Voir aussi

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 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.Each format item is replaced by the string representation of a corresponding argument in a parameter array.

public:
 System::Text::StringBuilder ^ AppendFormat(System::String ^ format, ... cli::array <System::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.A composite format string.

args
Object[]

Tableau d'objets à mettre en forme.An array of objects to format.

Retours

Référence à cette instance après l'ajout de format.A reference to this instance with format appended. 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.Each format item in format is replaced by the string representation of the corresponding object argument.

Exceptions

format ou args est null.format or args is null.

format n'est pas valide.format is invalid.

- ou --or-

L’index d’un élément de format est inférieur à 0 (zéro), ou supérieur ou égal à la longueur du tableau args.The index of a format item is less than 0 (zero), or greater than or equal to the length of the args array.

La longueur de la chaîne développée dépasserait MaxCapacity.The length of the expanded string would exceed MaxCapacity.

Exemples

L’exemple suivant illustre la méthode AppendFormat.The following example demonstrates the AppendFormat method.

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
*/
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 StringBuilder actuel.This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

Le paramètre format se compose de zéro, une ou plusieurs exécutions de texte mélangées à zéro, un 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.The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to objects in the parameter list of this method. 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.The formatting process replaces each format item with the string representation of the corresponding object.

La syntaxe d’un élément de format est la suivante :The syntax of a format item is as follows:

{index[,longueur] [ :FormatString]}{index[,length][:formatString]}

Les éléments entre crochets sont facultatifs.Elements in square brackets are optional. Le tableau suivant décrit chaque élément.The following table describes each element.

ÉlémentElement DescriptionDescription
indexindex Position de base zéro dans la liste de paramètres de l’objet à mettre en forme.The zero-based position in the parameter list of the object to be formatted. Si l’objet spécifié par l' index est null, l’élément de mise en forme est remplacé par String.Empty.If the object specified by index is null, the format item is replaced by String.Empty. S’il n’y a aucun paramètre dans la position d' index , une FormatException est levée.If there is no parameter in the index position, a FormatException is thrown.
,length,length Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre.The minimum number of characters in the string representation of the parameter. Si la condition est positive, le paramètre est aligné à droite ; Si la valeur est négative, elle est alignée à gauche.If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.A standard or custom format string that is supported by the parameter.

Notes

Pour les chaînes de format standard et personnalisées utilisées avec les valeurs de date et d’heure, consultez chaînes de format de date et d' heure standard et chaînes de format de date et d’heure personnalisées.For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. Pour 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.For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. Pour les chaînes de format standard utilisées avec les énumérations, consultez chaînes de format d’énumération.For the standard format strings used with enumerations, see Enumeration Format Strings.

args représente les objets à mettre en forme.args represents the objects to be formatted. Chaque élément de mise en forme dans format est remplacé par la représentation sous forme de chaîne de l’objet correspondant dans args.Each format item in format is replaced with the string representation of the corresponding object in args. Si l’élément de mise en forme comprend des formatString et que l’objet correspondant dans args implémente l’interface IFormattable, args[index].ToString(formatString, provider) définit la mise en forme.If the format item includes formatString and the corresponding object in args implements the IFormattable interface, then args[index].ToString(formatString, provider) defines the formatting. Dans le cas contraire, args[index].ToString() définit la mise en forme.Otherwise, args[index].ToString() defines the formatting.

Si la chaîne assignée à format est « Merci pour votre don de {0 : # # # #} boîtes de nourriture à notre organisation charitable ».If the string assigned to format is "Thank you for your donation of {0:####} cans of food to our charitable organization." et arg0 est un entier ayant la valeur 10, la valeur de retour est « Merci pour votre don de 10 boîtes de nourriture à notre organisation charitable ».and arg0 is an integer with the value 10, the return value will be "Thank you for your donation of 10 cans of food to our charitable organization."

Notes pour les appelants

Dans .NET Core et dans le .NET Framework 4,0 et versions ultérieures, quand vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent croître au-delà de la valeur de sa propriété MaxCapacity.In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter des chaînes de petite taille.This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

Voir aussi

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 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é.Each format item is replaced by the string representation of a single argument using a specified format provider.

public:
 System::Text::StringBuilder ^ AppendFormat(IFormatProvider ^ provider, System::String ^ format, System::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.An object that supplies culture-specific formatting information.

format
String

Chaîne de format composite.A composite format string.

arg0
Object

Objet à mettre en forme.The object to format.

Retours

Référence à cette instance après l'opération d'ajout.A reference to this instance after the append operation has completed. 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.After the append operation, this instance contains any data that existed before the operation, suffixed by a copy of format in which any format specification is replaced by the string representation of arg0.

Exceptions

format est null.format is null.

format n'est pas valide.format is invalid.

- ou --or-

L’index d’un élément de format est inférieur à 0 (zéro), ou supérieur ou égal à 1 (un).The index of a format item is less than 0 (zero), or greater than or equal to one (1).

La longueur de la chaîne développée dépasserait MaxCapacity.The length of the expanded string would exceed MaxCapacity.

Exemples

Les éléments suivants incluent deux appels à la méthode AppendFormat(IFormatProvider, String, Object).The following includes two calls to the AppendFormat(IFormatProvider, String, Object) method. Les deux utilisent les conventions de mise en forme de la culture anglais-Grande-Bretagne (en-GB).Both use the formatting conventions of the English-Great Britain (en-GB) culture. 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.The first inserts the string representation of a Decimal value currency in a result string. Le deuxième insère une valeur DateTime à deux emplacements dans une chaîne de résultat, le premier incluant uniquement la chaîne de date abrégée et la deuxième chaîne d’heure abrégée.The second inserts a DateTime value in two places in a result string, the first including only the short date string and the second the short time string.

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
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 de l' .NET Framework pour convertir la valeur de arg0 en sa représentation textuelle et incorporer cette représentation dans l’objet StringBuilder actuel.This method uses the composite formatting feature of the .NET Framework to convert the value of arg0 to its text representation and embed that representation in the current StringBuilder object.

Le paramètre format se compose de zéro, une ou plusieurs exécutions de texte mélangées à zéro, un ou plusieurs espaces réservés indexés, appelés éléments de format.The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items. L’index de chaque élément de mise en forme doit être égal à zéro (0), car cette méthode comprend une liste d’arguments avec un seul argument.The index of each format item must be zero (0) since this method includes an argument list with a single argument. Le processus de mise en forme remplace chaque élément de format par la représentation sous forme de chaîne de arg0.The formatting process replaces each format item with the string representation of arg0.

La syntaxe d’un élément de format est la suivante :The syntax of a format item is as follows:

{index[,longueur] [ :FormatString]}{index[,length][:formatString]}

Les éléments entre crochets sont facultatifs.Elements in square brackets are optional. Le tableau suivant décrit chaque élément.The following table describes each element.

ÉlémentElement DescriptionDescription
indexindex Position de base zéro dans la liste de paramètres de l’objet à mettre en forme.The zero-based position in the parameter list of the object to be formatted. Si l’objet spécifié par l' index est null, l’élément de mise en forme est remplacé par String.Empty.If the object specified by index is null, the format item is replaced by String.Empty. Dans ce cas, étant donné que la méthode AppendFormat(IFormatProvider, String, Object) possède un argument unique dans la liste d’arguments, la valeur de index doit toujours être 0.In this case, since the AppendFormat(IFormatProvider, String, Object) method has a single argument in the argument list, the value of index must always be 0. Si ce n’est pas le cas, une FormatException est levée.If it is not, a FormatException is thrown.
,length,length Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre.The minimum number of characters in the string representation of the parameter. Si la condition est positive, le paramètre est aligné à droite ; Si la valeur est négative, elle est alignée à gauche.If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.A standard or custom format string that is supported by the parameter.

Notes

Pour les chaînes de format standard et personnalisées utilisées avec les valeurs de date et d’heure, consultez chaînes de format de date et d' heure standard et chaînes de format de date et d’heure personnalisées.For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. Pour 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.For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. Pour les chaînes de format standard utilisées avec les énumérations, consultez chaînes de format d’énumération.For the standard format strings used with enumerations, see Enumeration Format Strings.

Le paramètre provider spécifie une implémentation IFormatProvider qui peut fournir des informations de mise en forme pour les objets dans args.The provider parameter specifies an IFormatProvider implementation that can provide formatting information for the objects in args. provider peut être l'une des fonctions suivantes :provider can be any of the following:

  • Objet CultureInfo qui fournit des informations de mise en forme propres à la culture.A CultureInfo object that provides culture-specific formatting information.

  • Objet NumberFormatInfo qui fournit des informations de mise en forme propres à la culture pour arg0 s’il s’agit d’une valeur numérique.A NumberFormatInfo object that provides culture-specific formatting information for arg0 if it is a numeric value.

  • 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.A DateTimeFormatInfo object that provides culture-specific formatting information for arg0 if it is a date and time value.

  • Implémentation de IFormatProvider personnalisée qui fournit des informations de mise en forme pour arg0.A custom IFormatProvider implementation that provides formatting information for arg0. En règle générale, une telle implémentation implémente également l’interface ICustomFormatter.Typically, such an implementation also implements the ICustomFormatter interface.

Si le paramètre provider est null, les informations de mise en forme sont obtenues à partir de la culture actuelle.If the provider parameter is null, formatting information is obtained from the current culture.

arg0 représente l’objet à mettre en forme.arg0 represents the object to be formatted. Chaque élément de mise en forme dans format est remplacé par la représentation sous forme de chaîne de arg0.Each format item in format is replaced with the string representation of arg0. Si l’élément de mise en forme comprend formatString et arg0 implémente l’interface IFormattable, arg0.ToString(formatString, provider) définit la mise en forme.If the format item includes formatString and arg0 implements the IFormattable interface, then arg0.ToString(formatString, provider) defines the formatting. Dans le cas contraire, arg0.ToString() définit la mise en forme.Otherwise, arg0.ToString() defines the formatting.

Notes pour les appelants

Dans .NET Core et dans le .NET Framework 4,0 et versions ultérieures, quand vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent croître au-delà de la valeur de sa propriété MaxCapacity.In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter des chaînes de petite taille.This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

Voir aussi

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 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é.Each format item is replaced by the string representation of a corresponding argument in a parameter array using a specified format provider.

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);
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.An object that supplies culture-specific formatting information.

format
String

Chaîne de format composite.A composite format string.

args
Object[]

Tableau d'objets à mettre en forme.An array of objects to format.

Retours

Référence à cette instance après l'opération d'ajout.A reference to this instance after the append operation has completed. 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.After the append operation, this instance contains any data that existed before the operation, suffixed by a copy of format where any format specification is replaced by the string representation of the corresponding object argument.

Exceptions

format est null.format is null.

format n'est pas valide.format is invalid.

- ou --or-

L’index d’un élément de format est inférieur à 0 (zéro), ou supérieur ou égal à la longueur du tableau args.The index of a format item is less than 0 (zero), or greater than or equal to the length of the args array.

La longueur de la chaîne développée dépasserait MaxCapacity.The length of the expanded string would exceed MaxCapacity.

Exemples

L’exemple suivant illustre la méthode AppendFormat.The following example demonstrates the AppendFormat method.

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
*/
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 de IFormatProvider personnalisée 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.The following example defines a custom IFormatProvider implementation named CustomerFormatter that formats a 10-digit customer number with hyphens after the fourth and seventh digits. Elle est transmise à la méthode StringBuilder.AppendFormat(IFormatProvider, String, Object[]) pour créer une chaîne qui comprend le numéro client et le nom du client mis en forme.It is passed to the StringBuilder.AppendFormat(IFormatProvider, String, Object[]) method to create a string that includes the formatted customer number and customer name.

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
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 StringBuilder actuel.This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

Le paramètre format se compose de zéro, une ou plusieurs exécutions de texte mélangées à zéro, un 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.The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to objects in the parameter list of this method. 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.The formatting process replaces each format item with the string representation of the corresponding object.

La syntaxe d’un élément de format est la suivante :The syntax of a format item is as follows:

{index[,longueur] [ :FormatString]}{index[,length][:formatString]}

Les éléments entre crochets sont facultatifs.Elements in square brackets are optional. Le tableau suivant décrit chaque élément.The following table describes each element.

ÉlémentElement DescriptionDescription
indexindex Position de base zéro dans la liste de paramètres de l’objet à mettre en forme.The zero-based position in the parameter list of the object to be formatted. Si l’objet spécifié par l' index est null, l’élément de mise en forme est remplacé par String.Empty.If the object specified by index is null, the format item is replaced by String.Empty. S’il n’y a aucun paramètre dans la position d' index , une FormatException est levée.If there is no parameter in the index position, a FormatException is thrown.
,length,length Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre.The minimum number of characters in the string representation of the parameter. Si la condition est positive, le paramètre est aligné à droite ; Si la valeur est négative, elle est alignée à gauche.If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.A standard or custom format string that is supported by the parameter.

Notes

Pour les chaînes de format standard et personnalisées utilisées avec les valeurs de date et d’heure, consultez chaînes de format de date et d' heure standard et chaînes de format de date et d’heure personnalisées.For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. Pour 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.For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. Pour les chaînes de format standard utilisées avec les énumérations, consultez chaînes de format d’énumération.For the standard format strings used with enumerations, see Enumeration Format Strings.

Le paramètre provider spécifie une implémentation IFormatProvider qui peut fournir des informations de mise en forme pour les objets dans args.The provider parameter specifies an IFormatProvider implementation that can provide formatting information for the objects in args. provider peut être l'une des fonctions suivantes :provider can be any of the following:

Si le paramètre provider est null, les informations de fournisseur de format sont obtenues à partir de la culture actuelle.If the provider parameter is null, format provider information is obtained from the current culture.

args représente les objets à mettre en forme.args represents the objects to be formatted. Chaque élément de mise en forme dans format est remplacé par la représentation sous forme de chaîne de l’objet correspondant dans args.Each format item in format is replaced with the string representation of the corresponding object in args. Si l’élément de mise en forme comprend des formatString et que l’objet correspondant dans args implémente l’interface IFormattable, args[index].ToString(formatString, provider) définit la mise en forme.If the format item includes formatString and the corresponding object in args implements the IFormattable interface, then args[index].ToString(formatString, provider) defines the formatting. Dans le cas contraire, args[index].ToString() définit la mise en forme.Otherwise, args[index].ToString() defines the formatting.

Notes pour les appelants

Dans .NET Core et dans le .NET Framework 4,0 et versions ultérieures, quand vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent croître au-delà de la valeur de sa propriété MaxCapacity.In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter des chaînes de petite taille.This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

Voir aussi

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l'un des deux arguments possibles.Each format item is replaced by the string representation of either of two arguments.

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);
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.A composite format string.

arg0
Object

Premier objet à mettre en forme.The first object to format.

arg1
Object

Deuxième objet à mettre en forme.The second object to format.

Retours

Référence à cette instance après l'ajout de format.A reference to this instance with format appended. 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.Each format item in format is replaced by the string representation of the corresponding object argument.

Exceptions

format est null.format is null.

format n'est pas valide.format is invalid.

- ou --or-

L’index d’un élément de format est inférieur à 0 (zéro), ou supérieur ou égal à 2.The index of a format item is less than 0 (zero), or greater than or equal to 2.

La longueur de la chaîne développée dépasserait MaxCapacity.The length of the expanded string would exceed MaxCapacity.

Exemples

L’exemple suivant illustre la méthode AppendFormat.The following example demonstrates the AppendFormat method.

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
*/
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 StringBuilder actuel.This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

Le paramètre format se compose de zéro, une ou plusieurs exécutions de texte mélangées à zéro, un ou plusieurs espaces réservés indexés, appelés éléments de format, qui correspondent à arg0 et arg1, les deux objets de la liste de paramètres de cette méthode.The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to arg0 and arg1, the two objects in the parameter list of this method. 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.The formatting process replaces each format item with the string representation of the corresponding object.

La syntaxe d’un élément de format est la suivante :The syntax of a format item is as follows:

{index[,longueur] [ :FormatString]}{index[,length][:formatString]}

Les éléments entre crochets sont facultatifs.Elements in square brackets are optional. Le tableau suivant décrit chaque élément.The following table describes each element.

ÉlémentElement DescriptionDescription
indexindex Position de base zéro dans la liste de paramètres de l’objet à mettre en forme.The zero-based position in the parameter list of the object to be formatted. Si l’objet spécifié par l' index est null, l’élément de mise en forme est remplacé par String.Empty.If the object specified by index is null, the format item is replaced by String.Empty. S’il n’y a aucun paramètre dans la position d' index , une FormatException est levée.If there is no parameter in the index position, a FormatException is thrown.
,length,length Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre.The minimum number of characters in the string representation of the parameter. Si la condition est positive, le paramètre est aligné à droite ; Si la valeur est négative, elle est alignée à gauche.If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.A standard or custom format string that is supported by the parameter.

Notes

Pour les chaînes de format standard et personnalisées utilisées avec les valeurs de date et d’heure, consultez chaînes de format de date et d' heure standard et chaînes de format de date et d’heure personnalisées.For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. Pour 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.For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. Pour les chaînes de format standard utilisées avec les énumérations, consultez chaînes de format d’énumération.For the standard format strings used with enumerations, see Enumeration Format Strings.

arg0 et arg1 représentent les objets à mettre en forme.arg0 and arg1 represent the objects to be formatted. Chaque élément de mise en forme dans format est remplacé par la représentation sous forme de chaîne de arg0 ou arg1.Each format item in format is replaced with the string representation of either arg0 or arg1. Si l’élément de mise en forme comprend des 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.If the format item includes formatString and the corresponding object implements the IFormattable interface, then argx.ToString(formatString, provider) defines the formatting, where x is the index of the argument. Dans le cas contraire, argx.ToString() définit la mise en forme.Otherwise, argx.ToString() defines the formatting.

Si la chaîne assignée à format est « Merci pour votre don de {0 : # # # #} boîtes de nourriture à notre organisation charitable ».If the string assigned to format is "Thank you for your donation of {0:####} cans of food to our charitable organization." et arg0 est un entier ayant la valeur 10, la valeur de retour est « Merci pour votre don de 10 boîtes de nourriture à notre organisation charitable ».and arg0 is an integer with the value 10, the return value will be "Thank you for your donation of 10 cans of food to our charitable organization."

Notes pour les appelants

Dans .NET Core et dans le .NET Framework 4,0 et versions ultérieures, quand vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent croître au-delà de la valeur de sa propriété MaxCapacity.In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter des chaînes de petite taille.This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

Voir aussi

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. 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é.Each format item is replaced by the string representation of either of two arguments using a specified format provider.

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);
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.An object that supplies culture-specific formatting information.

format
String

Chaîne de format composite.A composite format string.

arg0
Object

Premier objet à mettre en forme.The first object to format.

arg1
Object

Deuxième objet à mettre en forme.The second object to format.

Retours

Référence à cette instance après l'opération d'ajout.A reference to this instance after the append operation has completed. 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.After the append operation, this instance contains any data that existed before the operation, suffixed by a copy of format where any format specification is replaced by the string representation of the corresponding object argument.

Exceptions

format a la valeur null.format is null.

format n'est pas valide.format is invalid.

- ou --or-

L’index d’un élément de format est inférieur à 0 (zéro), ou supérieur ou égal à 2 (deux).The index of a format item is less than 0 (zero), or greater than or equal to 2 (two).

La longueur de la chaîne développée dépasserait MaxCapacity.The length of the expanded string would exceed 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.The following example uses the AppendFormat(IFormatProvider, String, Object, Object) method to display time and temperature data stored in a generic Dictionary<TKey,TValue> object. Notez que la chaîne de format comporte trois éléments de mise en forme, bien qu’il n’y ait qu’un seul objet à mettre en forme.Note that the format string has three format items, although there are only to objects to format. Cela est dû au fait que le premier objet de la liste (une valeur de date et d’heure) est utilisé par deux éléments de mise en forme : le premier élément de mise en forme affiche l’heure, tandis que le deuxième affiche la date.This is because the first object in the list (a date and time value) is used by two format items: The first format item displays the time, and the second displays the 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
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 StringBuilder actuel.This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

Le paramètre format se compose de zéro, une ou plusieurs exécutions de texte mélangées à zéro, un 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.The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to objects in the parameter list of this method. 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.The formatting process replaces each format item with the string representation of the corresponding object.

La syntaxe d’un élément de format est la suivante :The syntax of a format item is as follows:

{index[,longueur] [ :FormatString]}{index[,length][:formatString]}

Les éléments entre crochets sont facultatifs.Elements in square brackets are optional. Le tableau suivant décrit chaque élément.The following table describes each element.

ÉlémentElement DescriptionDescription
indexindex Position de base zéro dans la liste de paramètres de l’objet à mettre en forme.The zero-based position in the parameter list of the object to be formatted. Si l’objet spécifié par l' index est null, l’élément de mise en forme est remplacé par String.Empty.If the object specified by index is null, the format item is replaced by String.Empty. S’il n’y a aucun paramètre dans la position d' index , une FormatException est levée.If there is no parameter in the index position, a FormatException is thrown.
,length,length Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre.The minimum number of characters in the string representation of the parameter. Si la condition est positive, le paramètre est aligné à droite ; Si la valeur est négative, elle est alignée à gauche.If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.A standard or custom format string that is supported by the parameter.

Notes

Pour les chaînes de format standard et personnalisées utilisées avec les valeurs de date et d’heure, consultez chaînes de format de date et d' heure standard et chaînes de format de date et d’heure personnalisées.For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. Pour 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.For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. Pour les chaînes de format standard utilisées avec les énumérations, consultez chaînes de format d’énumération.For the standard format strings used with enumerations, see Enumeration Format Strings.

Le paramètre provider spécifie une implémentation IFormatProvider qui peut fournir des informations de mise en forme pour arg0 et arg1.The provider parameter specifies an IFormatProvider implementation that can provide formatting information for arg0 and arg1. provider peut être l'une des fonctions suivantes :provider can be any of the following:

  • Objet CultureInfo qui fournit des informations de mise en forme propres à la culture.A CultureInfo object that provides culture-specific formatting information.

  • Objet NumberFormatInfo qui fournit des informations de mise en forme propres à la culture pour arg0 ou arg1 s’il s’agit de valeurs numériques.A NumberFormatInfo object that provides culture-specific formatting information for arg0 or arg1 if they are numeric values.

  • Objet DateTimeFormatInfo qui fournit des informations de mise en forme propres à la culture pour arg0 ou arg1 s’il s’agit de valeurs de date et d’heure.A DateTimeFormatInfo object that provides culture-specific formatting information for arg0 or arg1 if they are date and time values.

  • Implémentation de IFormatProvider personnalisée qui fournit des informations de mise en forme pour arg0 et arg1.A custom IFormatProvider implementation that provides formatting information for arg0 and arg1. En règle générale, une telle implémentation implémente également l’interface ICustomFormatter.Typically, such an implementation also implements the ICustomFormatter interface.

Si le paramètre provider est null, les informations de fournisseur de format sont obtenues à partir de la culture actuelle.If the provider parameter is null, format provider information is obtained from the current culture.

arg0 et arg1 représentent les objets à mettre en forme.arg0 and arg1 represent the objects to be formatted. Chaque élément de mise en forme dans format est remplacé par la représentation sous forme de chaîne de l’objet qui a l’index correspondant.Each format item in format is replaced with the string representation of the object that has the corresponding index. Si l’élément de mise en forme comprend des 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.If the format item includes formatString and the corresponding argument implements the IFormattable interface, then the argument's ToString(formatString, provider) method defines the formatting. Sinon, la méthode ToString() de l’argument définit la mise en forme.Otherwise, the argument's ToString() method defines the formatting.

Notes pour les appelants

Dans .NET Core et dans le .NET Framework 4,0 et versions ultérieures, quand vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent croître au-delà de la valeur de sa propriété MaxCapacity.IIn .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter des chaînes de petite taille.This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

Voir aussi

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.Appends the string returned by processing a composite format string, which contains zero or more format items, to this instance. Chaque élément de format est remplacé par la représentation sous forme de chaîne de l'un des trois arguments possibles.Each format item is replaced by the string representation of either of three arguments.

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);
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.A composite format string.

arg0
Object

Premier objet à mettre en forme.The first object to format.

arg1
Object

Deuxième objet à mettre en forme.The second object to format.

arg2
Object

Troisième objet à mettre en forme.The third object to format.

Retours

Référence à cette instance après l'ajout de format.A reference to this instance with format appended. 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.Each format item in format is replaced by the string representation of the corresponding object argument.

Exceptions

format a la valeur null.format is null.

format n'est pas valide.format is invalid.

- ou --or-

L’index d’un élément de format est inférieur à 0 (zéro), ou supérieur ou égal à 3.The index of a format item is less than 0 (zero), or greater than or equal to 3.

La longueur de la chaîne développée dépasserait MaxCapacity.The length of the expanded string would exceed MaxCapacity.

Exemples

L’exemple suivant illustre la méthode AppendFormat.The following example demonstrates the AppendFormat method.

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
*/
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 StringBuilder actuel.This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in the current StringBuilder object.

Le paramètre format se compose de zéro, une ou plusieurs exécutions de texte mélangées à zéro, un ou plusieurs espaces réservés indexés, appelés éléments de format, qui correspondent à des arg0 par arg2, les objets de la liste de paramètres de cette méthode.The format parameter consists of zero or more runs of text intermixed with zero or more indexed placeholders, called format items, that correspond to arg0 through arg2, the objects in the parameter list of this method. 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.The formatting process replaces each format item with the string representation of the corresponding object.

La syntaxe d’un élément de format est la suivante :The syntax of a format item is as follows:

{index[,longueur] [ :FormatString]}{index[,length][:formatString]}

Les éléments entre crochets sont facultatifs.Elements in square brackets are optional. Le tableau suivant décrit chaque élément.The following table describes each element.

ÉlémentElement DescriptionDescription
indexindex Position de base zéro dans la liste de paramètres de l’objet à mettre en forme.The zero-based position in the parameter list of the object to be formatted. Si l’objet spécifié par l' index est null, l’élément de mise en forme est remplacé par String.Empty.If the object specified by index is null, the format item is replaced by String.Empty. S’il n’y a aucun paramètre dans la position d' index , une FormatException est levée.If there is no parameter in the index position, a FormatException is thrown.
,length,length Nombre minimal de caractères dans la représentation sous forme de chaîne du paramètre.The minimum number of characters in the string representation of the parameter. Si la condition est positive, le paramètre est aligné à droite ; Si la valeur est négative, elle est alignée à gauche.If positive, the parameter is right-aligned; if negative, it is left-aligned.
:formatString:formatString Chaîne de format standard ou personnalisée prise en charge par le paramètre.A standard or custom format string that is supported by the parameter.

Notes

Pour les chaînes de format standard et personnalisées utilisées avec les valeurs de date et d’heure, consultez chaînes de format de date et d' heure standard et chaînes de format de date et d’heure personnalisées.For the standard and custom format strings used with date and time values, see Standard Date and Time Format Strings and Custom Date and Time Format Strings. Pour 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.For the standard and custom format strings used with numeric values, see Standard Numeric Format Strings and Custom Numeric Format Strings. Pour les chaînes de format standard utilisées avec les énumérations, consultez chaînes de format d’énumération.For the standard format strings used with enumerations, see Enumeration Format Strings.

arg0, arg1et arg2 représentent les objets à mettre en forme.arg0, arg1, and arg2 represent the objects to be formatted. Chaque élément de mise en forme 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 mise en forme.Each format item in format is replaced with the string representation of either arg0, arg1, or arg2, depending on the index of the format item. Si l’élément de mise en forme comprend des 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.If the format item includes formatString and the corresponding object in args implements the IFormattable interface, then argx.ToString(formatString, null) defines the formatting, where x is the index of the argument. Dans le cas contraire, argx.ToString() définit la mise en forme.Otherwise, argx.ToString() defines the formatting.

Si la chaîne assignée à format est « Merci pour votre don de {0 : # # # #} boîtes de nourriture à notre organisation charitable ».If the string assigned to format is "Thank you for your donation of {0:####} cans of food to our charitable organization." et arg0 est un entier ayant la valeur 10, la valeur de retour est « Merci pour votre don de 10 boîtes de nourriture à notre organisation charitable ».and arg0 is an integer with the value 10, the return value will be "Thank you for your donation of 10 cans of food to our charitable organization."

Notes pour les appelants

Dans .NET Core et dans le .NET Framework 4,0 et versions ultérieures, quand vous instanciez l’objet StringBuilder en appelant le constructeur StringBuilder(Int32, Int32), la longueur et la capacité de l’instance StringBuilder peuvent croître au-delà de la valeur de sa propriété MaxCapacity.In .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. Cela peut se produire en particulier lorsque vous appelez les méthodes Append(String) et AppendFormat(String, Object) pour ajouter des chaînes de petite taille.This can occur particularly when you call the Append(String) and AppendFormat(String, Object) methods to append small strings.

Voir aussi

S’applique à