String.Format Méthode

Définition

Espace de noms:

System

Assembly:

System.Runtime.dll

Convertit la valeur des objets en chaînes en fonction des formats spécifiés et les insère dans une autre chaîne.

Si vous débutez avec la méthode String.Format, consultez prise en main de la méthode String.Format pour obtenir une vue d’ensemble rapide.

Surcharges

Format(IFormatProvider, String, Object[])	Remplace les éléments de format dans une chaîne par les représentations sous forme de chaîne d’objets correspondants dans un tableau spécifié. Un paramètre fournit des informations de mise en forme propres à la culture.
Format(IFormatProvider, String, Object, Object, Object)	Remplace les éléments de format dans une chaîne par la représentation sous forme de chaîne de trois objets spécifiés. Un paramètre fournit des informations de mise en forme propres à la culture.
Format(String, Object, Object, Object)	Remplace les éléments de format dans une chaîne par la représentation sous forme de chaîne de trois objets spécifiés.
Format(IFormatProvider, String, Object, Object)	Remplace les éléments de format dans une chaîne par la représentation sous forme de chaîne de deux objets spécifiés. Un paramètre fournit des informations de mise en forme propres à la culture.
Format(String, Object, Object)	Remplace les éléments de format dans une chaîne par la représentation sous forme de chaîne de deux objets spécifiés.
Format(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)	Remplace l’élément de format ou les éléments d’un CompositeFormat par la représentation sous forme de chaîne des objets correspondants au format spécifié.
Format(IFormatProvider, String, Object)	Remplace l’élément de format ou les éléments d’une chaîne spécifiée par la représentation sous forme de chaîne de l’objet correspondant. Un paramètre fournit des informations de mise en forme propres à la culture.
Format(String, Object[])	Remplace l’élément de format dans une chaîne spécifiée par la représentation sous forme de chaîne d’un objet correspondant dans un tableau spécifié.
Format(String, Object)	Remplace un ou plusieurs éléments de format dans une chaîne par la représentation sous forme de chaîne d’un objet spécifié.
Format(IFormatProvider, CompositeFormat, Object[])	Remplace l’élément de format ou les éléments d’un CompositeFormat par la représentation sous forme de chaîne des objets correspondants au format spécifié.
Format<TArg0,TArg1,TArg2>(IFormatProvider, CompositeFormat, TArg0, TArg1, TArg2)	Remplace l’élément de format ou les éléments d’un CompositeFormat par la représentation sous forme de chaîne des objets correspondants au format spécifié.
Format<TArg0,TArg1>(IFormatProvider, CompositeFormat, TArg0, TArg1)	Remplace l’élément de format ou les éléments d’un CompositeFormat par la représentation sous forme de chaîne des objets correspondants au format spécifié.
Format<TArg0>(IFormatProvider, CompositeFormat, TArg0)	Remplace l’élément de format ou les éléments d’un CompositeFormat par la représentation sous forme de chaîne des objets correspondants au format spécifié.

Remarques

Pour plus d’informations sur cette API, consultez remarques d’API supplémentaires pour String.Format.

Format(IFormatProvider, String, Object[])

Source:

String.Manipulation.cs

Remplace les éléments de format dans une chaîne par les représentations sous forme de chaîne d’objets correspondants dans un tableau spécifié. Un paramètre fournit des informations de mise en forme propres à la culture.

C#

public static string Format (IFormatProvider? provider, string format, params object?[] args);

Paramètres

provider

IFormatProvider

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

format

String

Chaîne de format composite .

args

Object[]

Tableau d’objets qui contient zéro ou plusieurs objets à mettre en forme.

Retours

String

Copie de format dans laquelle les éléments de format ont été remplacés par la représentation sous forme de chaîne des objets correspondants dans args.

Exceptions

ArgumentNullException

format ou args est null.

FormatException

format n’est pas valide.

-ou-

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

Remarques

Important

Au lieu d’appeler la méthode string.Format ou d’utiliser chaînes de format composite, vous pouvez utiliser chaînes interpolées si votre langue les prend en charge. Une chaîne interpolée est une chaîne qui contient expressions interpolées. Chaque expression interpolée est résolue avec la valeur de l’expression et incluse dans la chaîne de résultat lorsque la chaîne est affectée. Pour plus d’informations, consultez et chaînes interpolées (référence Visual Basic).

Cette méthode utilise la fonctionnalité de mise en forme composite pour convertir quatre expressions ou plus en représentations sous forme de chaîne et incorporer ces représentations dans une chaîne. Lors de l’exécution de la conversion, la méthode utilise une mise en forme sensible à la culture ou un formateur personnalisé. La méthode convertit chaque argument Object en sa représentation sous forme de chaîne en appelant sa méthode ToString(IFormatProvider) ou, si l’élément de format correspondant de l’objet inclut une chaîne de format, en appelant sa méthode ToString(String,IFormatProvider). Si ces méthodes n’existent pas, elle appelle la méthode sans paramètre de l’objet ToString.

Toutefois, lors de l’appel de la méthode String.Format, il n’est pas nécessaire de se concentrer sur la surcharge particulière que vous souhaitez appeler. Au lieu de cela, vous pouvez appeler la méthode avec un objet qui fournit une mise en forme sensible à la culture ou personnalisée et une chaîne de format composite qui inclut un ou plusieurs éléments de format. Vous affectez à chaque élément de format un index numérique ; le premier index commence à 0. En plus de la chaîne initiale, votre appel de méthode doit avoir autant d’arguments supplémentaires qu’il a des valeurs d’index. Par exemple, une chaîne dont les éléments de format ont des index de 0 et 1 doit avoir 2 arguments ; une avec les index 0 à 5 doit avoir 6 arguments. Le compilateur de langage résout ensuite votre appel de méthode à une surcharge particulière de la méthode String.Format.

Pour obtenir une documentation plus détaillée sur l’utilisation de la méthode String.Format, consultez Prise en main de la méthode String.Format et Quelle méthode dois-je appeler ?.

Exemple : mise en forme sensible à la culture

Cet exemple utilise la méthode Format(IFormatProvider, String, Object[]) pour afficher la représentation sous forme de chaîne de certaines valeurs de date et d’heure et de valeurs numériques à l’aide de plusieurs cultures différentes.

C#

string[] cultureNames = { "en-US", "fr-FR", "de-DE", "es-ES" };

DateTime dateToDisplay = new DateTime(2009, 9, 1, 18, 32, 0);
double value = 9164.32;

Console.WriteLine("Culture     Date                                Value\n");
foreach (string cultureName in cultureNames)
{
   System.Globalization.CultureInfo culture = new System.Globalization.CultureInfo(cultureName);
   string output = String.Format(culture, "{0,-11} {1,-35:D} {2:N}", 
                                 culture.Name, dateToDisplay, value);
   Console.WriteLine(output);
}    
// The example displays the following output:
//    Culture     Date                                Value
//    
//    en-US       Tuesday, September 01, 2009         9,164.32
//    fr-FR       mardi 1 septembre 2009              9 164,32
//    de-DE       Dienstag, 1. September 2009         9.164,32
//    es-ES       martes, 01 de septiembre de 2009    9.164,32

Voir aussi

• DateTimeFormatInfo
• ICustomFormatter
• IFormatProvider
• NumberFormatInfo
• types de mise en forme dans .NET
• de mise en forme composite
• chaînes de format de date et d’heure standard
• chaînes de format de date et d’heure personnalisées
• chaînes de format numérique standard
• chaînes de format numérique personnalisées
• chaînes de format timeSpan standard
• chaînes de format timeSpan personnalisées
• chaînes de format d’énumération

Format(IFormatProvider, String, Object, Object, Object)

Source:

String.Manipulation.cs

Remplace les éléments de format dans une chaîne par la représentation sous forme de chaîne de trois objets spécifiés. Un paramètre fournit des informations de mise en forme propres à la culture.

C#

public static string Format (IFormatProvider? provider, string format, object? arg0, object? arg1, object? arg2);

Paramètres

provider

IFormatProvider

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

format

String

Chaîne de format composite .

arg0

Object

Premier objet à mettre en forme.

arg1

Object

Deuxième objet à mettre en forme.

arg2

Object

Troisième objet à mettre en forme.

Retours

String

Copie de format dans laquelle les éléments de format ont été remplacés par les représentations sous forme de chaîne de arg0, arg1et arg2.

Exceptions

ArgumentNullException

format est null.

FormatException

format n’est pas valide.

-ou-

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

Remarques

Important

Au lieu d’appeler la méthode string.Format ou d’utiliser chaînes de format composite, vous pouvez utiliser chaînes interpolées si votre langue les prend en charge. Une chaîne interpolée est une chaîne qui contient expressions interpolées. Chaque expression interpolée est résolue avec la valeur de l’expression et incluse dans la chaîne de résultat lorsque la chaîne est affectée. Pour plus d’informations, consultez et chaînes interpolées (référence Visual Basic).

Cette méthode utilise la fonctionnalité de mise en forme composite pour convertir trois expressions en représentations sous forme de chaîne et incorporer ces représentations dans une chaîne. Lors de l’exécution de la conversion, la méthode utilise une mise en forme sensible à la culture ou un formateur personnalisé. La méthode convertit chaque argument Object en sa représentation sous forme de chaîne en appelant sa méthode ToString(IFormatProvider) ou, si l’élément de format correspondant de l’objet inclut une chaîne de format, en appelant sa méthode ToString(String,IFormatProvider). Si ces méthodes n’existent pas, elle appelle la méthode sans paramètre de l’objet ToString.

Toutefois, lors de l’appel de la méthode String.Format, il n’est pas nécessaire de se concentrer sur la surcharge particulière que vous souhaitez appeler. Au lieu de cela, vous pouvez appeler la méthode avec un objet qui fournit une mise en forme sensible à la culture ou personnalisée et une chaîne de format composite qui inclut un ou plusieurs éléments de format. Vous affectez à chaque élément de format un index numérique ; le premier index commence à 0. En plus de la chaîne initiale, votre appel de méthode doit avoir autant d’arguments supplémentaires qu’il a des valeurs d’index. Par exemple, une chaîne dont les éléments de format ont des index de 0 et 1 doit avoir 2 arguments ; une avec les index 0 à 5 doit avoir 6 arguments. Le compilateur de langage résout ensuite votre appel de méthode à une surcharge particulière de la méthode String.Format.

Pour obtenir une documentation plus détaillée sur l’utilisation de la méthode String.Format, consultez Prise en main de la méthode String.Format et Quelle méthode dois-je appeler ?.

Format(String, Object, Object, Object)

Source:

String.Manipulation.cs

Remplace les éléments de format dans une chaîne par la représentation sous forme de chaîne de trois objets spécifiés.

C#

public static string Format (string format, object? arg0, object? arg1, object? arg2);

Paramètres

format

String

Chaîne de format composite .

arg0

Object

Premier objet à mettre en forme.

arg1

Object

Deuxième objet à mettre en forme.

arg2

Object

Troisième objet à mettre en forme.

Retours

String

Copie de format dans laquelle les éléments de format ont été remplacés par les représentations sous forme de chaîne de arg0, arg1et arg2.

Exceptions

ArgumentNullException

format est null.

FormatException

format n’est pas valide.

-ou-

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

Remarques

Important

Au lieu d’appeler la méthode string.Format ou d’utiliser chaînes de format composite, vous pouvez utiliser chaînes interpolées si votre langue les prend en charge. Une chaîne interpolée est une chaîne qui contient expressions interpolées. Chaque expression interpolée est résolue avec la valeur de l’expression et incluse dans la chaîne de résultat lorsque la chaîne est affectée. Pour plus d’informations, consultez et chaînes interpolées (référence Visual Basic).

Cette méthode utilise la fonctionnalité de mise en forme composite pour convertir la valeur de trois expressions en leurs représentations sous forme de chaîne et incorporer ces représentations dans une chaîne.

Toutefois, lors de l’appel de la méthode String.Format, il n’est pas nécessaire de se concentrer sur la surcharge particulière que vous souhaitez appeler. Au lieu de cela, vous pouvez appeler la méthode avec une chaîne de format composite qui inclut un ou plusieurs éléments de format. Vous affectez à chaque élément de format un index numérique ; le premier index commence à 0. En plus de la chaîne initiale, votre appel de méthode doit avoir autant d’arguments supplémentaires qu’il a des valeurs d’index. Par exemple, une chaîne dont les éléments de format ont des index de 0 et 1 doit avoir 2 arguments ; une avec les index 0 à 5 doit avoir 6 arguments. Le compilateur de langage résout ensuite votre appel de méthode à une surcharge particulière de la méthode String.Format.

Pour obtenir une documentation plus détaillée sur l’utilisation de la méthode String.Format, consultez Prise en main de la méthode String.Format et Quelle méthode dois-je appeler ?.

Exemple : Mettre en forme trois arguments

Cet exemple utilise la méthode Format(String, Object, Object, Object) pour créer une chaîne qui illustre le résultat d’une opération de And booléenne avec deux valeurs entières. Notez que la chaîne de format inclut six éléments de format, mais que la méthode n’a que trois éléments dans sa liste de paramètres, car chaque élément est mis en forme de deux façons différentes.

C#

string formatString = "    {0,10} ({0,8:X8})\n" + 
                      "And {1,10} ({1,8:X8})\n" + 
                      "  = {2,10} ({2,8:X8})";
int value1 = 16932;
int value2 = 15421;
string result = String.Format(formatString, 
                              value1, value2, value1 & value2);
Console.WriteLine(result);
// The example displays the following output:
//                16932 (00004224)
//       And      15421 (00003C3D)
//         =         36 (00000024)

Voir aussi

• types de mise en forme dans .NET
• de mise en forme composite

Format(IFormatProvider, String, Object, Object)

Source:

String.Manipulation.cs

Remplace les éléments de format dans une chaîne par la représentation sous forme de chaîne de deux objets spécifiés. Un paramètre fournit des informations de mise en forme propres à la culture.

C#

public static string Format (IFormatProvider? provider, string format, object? arg0, object? arg1);

Paramètres

provider

IFormatProvider

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

format

String

Chaîne de format composite .

arg0

Object

Premier objet à mettre en forme.

arg1

Object

Deuxième objet à mettre en forme.

Retours

String

Copie de format dans laquelle les éléments de format sont remplacés par les représentations sous forme de chaîne de arg0 et de arg1.

Exceptions

ArgumentNullException

format est null.

FormatException

format n’est pas valide.

-ou-

L’index d’un élément de format n’est pas égal ou égal à zéro.

Remarques

Important

Au lieu d’appeler la méthode string.Format ou d’utiliser chaînes de format composite, vous pouvez utiliser chaînes interpolées si votre langue les prend en charge. Une chaîne interpolée est une chaîne qui contient expressions interpolées. Chaque expression interpolée est résolue avec la valeur de l’expression et incluse dans la chaîne de résultat lorsque la chaîne est affectée. Pour plus d’informations, consultez et chaînes interpolées (référence Visual Basic).

Cette méthode utilise la fonctionnalité de mise en forme composite pour convertir deux expressions en représentations sous forme de chaîne et pour incorporer ces représentations dans une chaîne. Lors de l’exécution de la conversion, la méthode utilise une mise en forme sensible à la culture ou un formateur personnalisé. La méthode convertit chaque argument Object en sa représentation sous forme de chaîne en appelant sa méthode ToString(IFormatProvider) ou, si l’élément de format correspondant de l’objet inclut une chaîne de format, en appelant sa méthode ToString(String,IFormatProvider). Si ces méthodes n’existent pas, elle appelle la méthode sans paramètre de l’objet ToString.

Toutefois, lors de l’appel de la méthode String.Format, il n’est pas nécessaire de se concentrer sur la surcharge particulière que vous souhaitez appeler. Au lieu de cela, vous pouvez appeler la méthode avec un objet qui fournit une mise en forme sensible à la culture ou personnalisée et une chaîne de format composite qui inclut un ou plusieurs éléments de format. Vous affectez à chaque élément de format un index numérique ; le premier index commence à 0. En plus de la chaîne initiale, votre appel de méthode doit avoir autant d’arguments supplémentaires qu’il a des valeurs d’index. Par exemple, une chaîne dont les éléments de format ont des index de 0 et 1 doit avoir 2 arguments ; une avec les index 0 à 5 doit avoir 6 arguments. Le compilateur de langage résout ensuite votre appel de méthode à une surcharge particulière de la méthode String.Format.

Pour obtenir une documentation plus détaillée sur l’utilisation de la méthode String.Format, consultez Prise en main de la méthode String.Format et Quelle méthode dois-je appeler ?.

Format(String, Object, Object)

Source:

String.Manipulation.cs

Remplace les éléments de format dans une chaîne par la représentation sous forme de chaîne de deux objets spécifiés.

C#

public static string Format (string format, object? arg0, object? arg1);

Paramètres

format

String

Chaîne de format composite .

arg0

Object

Premier objet à mettre en forme.

arg1

Object

Deuxième objet à mettre en forme.

Retours

String

Copie de format dans laquelle les éléments de format sont remplacés par les représentations sous forme de chaîne de arg0 et de arg1.

Exceptions

ArgumentNullException

format est null.

FormatException

format n’est pas valide.

-ou-

L’index d’un élément de format n’est pas égal ou égal à zéro.

Remarques

Important

Au lieu d’appeler la méthode string.Format ou d’utiliser chaînes de format composite, vous pouvez utiliser chaînes interpolées si votre langue les prend en charge. Une chaîne interpolée est une chaîne qui contient expressions interpolées. Chaque expression interpolée est résolue avec la valeur de l’expression et incluse dans la chaîne de résultat lorsque la chaîne est affectée. Pour plus d’informations, consultez et chaînes interpolées (référence Visual Basic).

Cette méthode utilise la fonctionnalité de mise en forme composite pour convertir la valeur de deux expressions en leurs représentations sous forme de chaîne et pour incorporer ces représentations dans une chaîne.

Toutefois, lors de l’appel de la méthode String.Format, il n’est pas nécessaire de se concentrer sur la surcharge particulière que vous souhaitez appeler. Au lieu de cela, vous pouvez appeler la méthode avec une chaîne de format composite qui inclut un ou plusieurs éléments de format. Vous affectez à chaque élément de format un index numérique ; le premier index commence à 0. En plus de la chaîne initiale, votre appel de méthode doit avoir autant d’arguments supplémentaires qu’il a des valeurs d’index. Par exemple, une chaîne dont les éléments de format ont des index de 0 et 1 doit avoir 2 arguments ; une avec les index 0 à 5 doit avoir 6 arguments. Le compilateur de langage résout ensuite votre appel de méthode à une surcharge particulière de la méthode String.Format.

Pour obtenir une documentation plus détaillée sur l’utilisation de la méthode String.Format, consultez Prise en main de la méthode String.Format et Quelle méthode dois-je appeler ?.

Exemple : Mettre en forme deux arguments

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

C#

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

Console.WriteLine("Temperature Information:\n");
string output;   
foreach (var item in temperatureInfo)
{
   output = String.Format("Temperature at {0,8:t} on {0,9:d}: {1,5:N1}°F", 
                          item.Key, item.Value);
   Console.WriteLine(output);
}
// The example displays output like the following:
//       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

Voir aussi

• types de mise en forme dans .NET
• de mise en forme composite
• chaînes de format de date et d’heure standard
• chaînes de format de date et d’heure personnalisées
• chaînes de format numérique standard
• chaînes de format numérique personnalisées
• chaînes de format timeSpan standard
• chaînes de format timeSpan personnalisées
• chaînes de format d’énumération

Format(IFormatProvider, CompositeFormat, ReadOnlySpan<Object>)

Source:

String.Manipulation.cs

Remplace l’élément de format ou les éléments d’un CompositeFormat par la représentation sous forme de chaîne des objets correspondants au format spécifié.

C#

public static string Format (IFormatProvider? provider, System.Text.CompositeFormat format, ReadOnlySpan<object?> args);

Paramètres

provider

IFormatProvider

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

format

CompositeFormat

Un CompositeFormat.

args

ReadOnlySpan<Object>

Étendue d’objets à mettre en forme.

Retours

String

Chaîne mise en forme.

Exceptions

ArgumentNullException

format est null.

FormatException

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

Format(IFormatProvider, String, Object)

Source:

String.Manipulation.cs

Remplace l’élément de format ou les éléments d’une chaîne spécifiée par la représentation sous forme de chaîne de l’objet correspondant. Un paramètre fournit des informations de mise en forme propres à la culture.

C#

public static string Format (IFormatProvider? provider, string format, object? arg0);

Paramètres

provider

IFormatProvider

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

format

String

Chaîne de format composite .

arg0

Object

Objet à mettre en forme.

Retours

String

Copie de format dans laquelle l’élément de format ou les éléments ont été remplacés par la représentation sous forme de chaîne de arg0.

Exceptions

ArgumentNullException

format est null.

FormatException

format n’est pas valide.

-ou-

L’index d’un élément de format n’est pas égal à zéro.

Remarques

Important

Au lieu d’appeler la méthode string.Format ou d’utiliser chaînes de format composite, vous pouvez utiliser chaînes interpolées si votre langue les prend en charge. Une chaîne interpolée est une chaîne qui contient expressions interpolées. Chaque expression interpolée est résolue avec la valeur de l’expression et incluse dans la chaîne de résultat lorsque la chaîne est affectée. Pour plus d’informations, consultez et chaînes interpolées (référence Visual Basic).

Cette méthode utilise la fonctionnalité de mise en forme composite pour convertir la valeur d’une expression en sa représentation sous forme de chaîne et incorporer cette représentation dans une chaîne. Lors de l’exécution de la conversion, la méthode utilise une mise en forme sensible à la culture ou un formateur personnalisé. La méthode convertit arg0 en sa représentation sous forme de chaîne en appelant sa méthode ToString(IFormatProvider) ou, si l’élément de format correspondant de l’objet inclut une chaîne de format, en appelant sa méthode ToString(String,IFormatProvider). Si ces méthodes n’existent pas, elle appelle la méthode sans paramètre de l’objet ToString.

Toutefois, lors de l’appel de la méthode String.Format, il n’est pas nécessaire de se concentrer sur la surcharge particulière que vous souhaitez appeler. Au lieu de cela, vous pouvez appeler la méthode avec un objet qui fournit une mise en forme sensible à la culture ou personnalisée et une chaîne de format composite qui inclut un ou plusieurs éléments de format. Vous affectez à chaque élément de format un index numérique ; le premier index commence à 0. En plus de la chaîne initiale, votre appel de méthode doit avoir autant d’arguments supplémentaires qu’il a des valeurs d’index. Par exemple, une chaîne dont les éléments de format ont des index de 0 et 1 doit avoir 2 arguments ; une avec les index 0 à 5 doit avoir 6 arguments. Le compilateur de langage résout ensuite votre appel de méthode à une surcharge particulière de la méthode String.Format.

Pour obtenir une documentation plus détaillée sur l’utilisation de la méthode String.Format, consultez Prise en main de la méthode String.Format et Quelle méthode dois-je appeler ?.

Format(String, Object[])

Source:

String.Manipulation.cs

Remplace l’élément de format dans une chaîne spécifiée par la représentation sous forme de chaîne d’un objet correspondant dans un tableau spécifié.

C#

public static string Format (string format, params object?[] args);

Paramètres

format

String

Chaîne de format composite .

args

Object[]

Tableau d’objets qui contient zéro ou plusieurs objets à mettre en forme.

Retours

String

Copie de format dans laquelle les éléments de format ont été remplacés par la représentation sous forme de chaîne des objets correspondants dans args.

Exceptions

ArgumentNullException

format ou args est null.

FormatException

format n’est pas valide.

-ou-

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

Remarques

Important

Au lieu d’appeler la méthode string.Format ou d’utiliser chaînes de format composite, vous pouvez utiliser chaînes interpolées si votre langue les prend en charge. Une chaîne interpolée est une chaîne qui contient expressions interpolées. Chaque expression interpolée est résolue avec la valeur de l’expression et incluse dans la chaîne de résultat lorsque la chaîne est affectée. Pour plus d’informations, consultez et chaînes interpolées (référence Visual Basic).

Cette méthode utilise la fonctionnalité de mise en forme composite pour convertir la valeur de quatre expressions ou plus en leurs représentations sous forme de chaîne et incorporer ces représentations dans une chaîne. Étant donné que le paramètre args est marqué avec l’attribut System.ParamArrayAttribute, vous pouvez transmettre les objets à la méthode en tant qu’arguments individuels ou en tant qu’arguments Object tableau.

Toutefois, lors de l’appel de la méthode String.Format, il n’est pas nécessaire de se concentrer sur la surcharge particulière que vous souhaitez appeler. Au lieu de cela, vous pouvez appeler la méthode avec une chaîne de format composite qui inclut un ou plusieurs éléments de format. Vous affectez à chaque élément de format un index numérique ; le premier index commence à 0. En plus de la chaîne initiale, votre appel de méthode doit avoir autant d’arguments supplémentaires qu’il a des valeurs d’index. Par exemple, une chaîne dont les éléments de format ont des index de 0 et 1 doit avoir 2 arguments ; une avec les index 0 à 5 doit avoir 6 arguments. Le compilateur de langage résout ensuite votre appel de méthode à une surcharge particulière de la méthode String.Format.

Pour obtenir une documentation plus détaillée sur l’utilisation de la méthode String.Format, consultez Prise en main de la méthode String.Format et Quelle méthode dois-je appeler ?.

Exemple : Mettre en forme plus de trois arguments

Cet exemple crée une chaîne qui contient des données sur la température élevée et basse à une date particulière. La chaîne de format composite comporte cinq éléments de format dans l’exemple C# et six dans l’exemple Visual Basic. Deux des éléments de format définissent la largeur de la représentation sous forme de chaîne de leur valeur correspondante, et le premier élément de format inclut également une chaîne de format de date et d’heure standard.

C#

DateTime date1 = new DateTime(2009, 7, 1);
TimeSpan hiTime = new TimeSpan(14, 17, 32);
decimal hiTemp = 62.1m; 
TimeSpan loTime = new TimeSpan(3, 16, 10);
decimal loTemp = 54.8m; 

string result1 = String.Format("Temperature on {0:d}:\n{1,11}: {2} degrees (hi)\n{3,11}: {4} degrees (lo)", 
                               date1, hiTime, hiTemp, loTime, loTemp);
Console.WriteLine(result1);
Console.WriteLine();
     
string result2 = String.Format("Temperature on {0:d}:\n{1,11}: {2} degrees (hi)\n{3,11}: {4} degrees (lo)", 
                               new object[] { date1, hiTime, hiTemp, loTime, loTemp });
Console.WriteLine(result2);
// The example displays output like the following:
//       Temperature on 7/1/2009:
//          14:17:32: 62.1 degrees (hi)
//          03:16:10: 54.8 degrees (lo)
//       Temperature on 7/1/2009:
//          14:17:32: 62.1 degrees (hi)
//          03:16:10: 54.8 degrees (lo)

Vous pouvez également passer les objets à mettre en forme en tant que tableau plutôt qu’en tant que liste d’arguments.

C#

using System;

public class CityInfo
{
   public CityInfo(String name, int population, Decimal area, int year)
   {
      this.Name = name;
      this.Population = population;
      this.Area = area;
      this.Year = year;
   }
   
   public readonly String Name; 
   public readonly int Population;
   public readonly Decimal Area;
   public readonly int Year;
}

public class Example
{
   public static void Main()
   {
      CityInfo nyc2010 = new CityInfo("New York", 8175133, 302.64m, 2010);
      ShowPopulationData(nyc2010);
      CityInfo sea2010 = new CityInfo("Seattle", 608660, 83.94m, 2010);      
      ShowPopulationData(sea2010); 
   }

   private static void ShowPopulationData(CityInfo city)
   {
      object[] args = { city.Name, city.Year, city.Population, city.Area };
      String result = String.Format("{0} in {1}: Population {2:N0}, Area {3:N1} sq. feet", 
                                    args);
      Console.WriteLine(result); 
   }
}
// The example displays the following output:
//       New York in 2010: Population 8,175,133, Area 302.6 sq. feet
//       Seattle in 2010: Population 608,660, Area 83.9 sq. feet

Voir aussi

• types de mise en forme dans .NET
• de mise en forme composite
• chaînes de format de date et d’heure standard
• chaînes de format de date et d’heure personnalisées
• chaînes de format numérique standard
• chaînes de format numérique personnalisées
• chaînes de format timeSpan standard
• chaînes de format timeSpan personnalisées
• chaînes de format d’énumération

Format(String, Object)

Source:

String.Manipulation.cs

Remplace un ou plusieurs éléments de format dans une chaîne par la représentation sous forme de chaîne d’un objet spécifié.

C#

public static string Format (string format, object? arg0);

Paramètres

format

String

Chaîne de format composite .

arg0

Object

Objet à mettre en forme.

Retours

String

Copie de format dans laquelle tous les éléments de format sont remplacés par la représentation sous forme de chaîne de arg0.

Exceptions

ArgumentNullException

format est null.

FormatException

L’élément de format dans format n’est pas valide.

-ou-

L’index d’un élément de format n’est pas égal à zéro.

Remarques

Important

Au lieu d’appeler la méthode string.Format ou d’utiliser chaînes de format composite, vous pouvez utiliser chaînes interpolées si votre langue les prend en charge. Une chaîne interpolée est une chaîne qui contient expressions interpolées. Chaque expression interpolée est résolue avec la valeur de l’expression et incluse dans la chaîne de résultat lorsque la chaîne est affectée. Pour plus d’informations, consultez et chaînes interpolées (référence Visual Basic).

Cette méthode utilise la fonctionnalité de mise en forme composite pour convertir la valeur d’une expression en sa représentation sous forme de chaîne et incorporer cette représentation dans une chaîne.

Toutefois, lors de l’appel de la méthode String.Format, il n’est pas nécessaire de se concentrer sur la surcharge particulière que vous souhaitez appeler. Au lieu de cela, vous pouvez appeler la méthode avec une chaîne de format composite qui inclut un ou plusieurs éléments de format. Vous affectez à chaque élément de format un index numérique ; le premier index commence à 0. En plus de la chaîne initiale, votre appel de méthode doit avoir autant d’arguments supplémentaires qu’il a des valeurs d’index. Par exemple, une chaîne dont les éléments de format ont des index de 0 et 1 doit avoir 2 arguments ; une avec les index 0 à 5 doit avoir 6 arguments. Le compilateur de langage résout ensuite votre appel de méthode à une surcharge particulière de la méthode String.Format.

Pour obtenir une documentation plus détaillée sur l’utilisation de la méthode String.Format, consultez Prise en main de la méthode String.Format et Quelle méthode dois-je appeler ?.

Exemple : Mise en forme d’un seul argument

L’exemple suivant utilise la méthode Format(String, Object) pour incorporer l’âge d’un individu au milieu d’une chaîne.

C#

DateTime birthdate = new DateTime(1993, 7, 28);
DateTime[] dates = { new DateTime(1993, 8, 16), 
                     new DateTime(1994, 7, 28), 
                     new DateTime(2000, 10, 16), 
                     new DateTime(2003, 7, 27), 
                     new DateTime(2007, 5, 27) };

foreach (DateTime dateValue in dates)
{
   TimeSpan interval = dateValue - birthdate;
   // Get the approximate number of years, without accounting for leap years.
   int years = ((int) interval.TotalDays) / 365;
   // See if adding the number of years exceeds dateValue.
   string output;
   if (birthdate.AddYears(years) <= dateValue) {
      output = String.Format("You are now {0} years old.", years);
      Console.WriteLine(output);
   }   
   else {
      output = String.Format("You are now {0} years old.", years - 1);
      Console.WriteLine(output);
   }      
}
// The example displays the following output:
//       You are now 0 years old.
//       You are now 1 years old.
//       You are now 7 years old.
//       You are now 9 years old.
//       You are now 13 years old.

Voir aussi

• types de mise en forme dans .NET
• de mise en forme composite
• chaînes de format de date et d’heure standard
• chaînes de format de date et d’heure personnalisées
• chaînes de format numérique standard
• chaînes de format numérique personnalisées
• chaînes de format timeSpan standard
• chaînes de format timeSpan personnalisées
• chaînes de format d’énumération

Format(IFormatProvider, CompositeFormat, Object[])

Source:

String.Manipulation.cs

Remplace l’élément de format ou les éléments d’un CompositeFormat par la représentation sous forme de chaîne des objets correspondants au format spécifié.

C#

public static string Format (IFormatProvider? provider, System.Text.CompositeFormat format, params object?[] args);

Paramètres

provider

IFormatProvider

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

format

CompositeFormat

Un CompositeFormat.

args

Object[]

Tableau d’objets à mettre en forme.

Retours

String

Chaîne mise en forme.

Exceptions

ArgumentNullException

format ou args est null.

FormatException

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

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

Source:

String.Manipulation.cs

Remplace l’élément de format ou les éléments d’un CompositeFormat par la représentation sous forme de chaîne des objets correspondants au format spécifié.

C#

public static string Format<TArg0,TArg1,TArg2> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0, TArg1 arg1, TArg2 arg2);

Paramètres de type

TArg0

Type du premier objet à mettre en forme.

TArg1

Type du deuxième objet à mettre en forme.

TArg2

Type du troisième objet à mettre en forme.

Paramètres

provider

IFormatProvider

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

format

CompositeFormat

Un CompositeFormat.

arg0

TArg0

Premier objet à mettre en forme.

arg1

TArg1

Deuxième objet à mettre en forme.

arg2

TArg2

Troisième objet à mettre en forme.

Retours

String

Chaîne mise en forme.

Exceptions

ArgumentNullException

format est null.

FormatException

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

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

Source:

String.Manipulation.cs

Remplace l’élément de format ou les éléments d’un CompositeFormat par la représentation sous forme de chaîne des objets correspondants au format spécifié.

C#

public static string Format<TArg0,TArg1> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0, TArg1 arg1);

Paramètres de type

TArg0

Type du premier objet à mettre en forme.

TArg1

Type du deuxième objet à mettre en forme.

Paramètres

provider

IFormatProvider

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

format

CompositeFormat

Un CompositeFormat.

arg0

TArg0

Premier objet à mettre en forme.

arg1

TArg1

Deuxième objet à mettre en forme.

Retours

String

Chaîne mise en forme.

Exceptions

ArgumentNullException

format est null.

FormatException

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

Format<TArg0>(IFormatProvider, CompositeFormat, TArg0)

Source:

String.Manipulation.cs

Remplace l’élément de format ou les éléments d’un CompositeFormat par la représentation sous forme de chaîne des objets correspondants au format spécifié.

C#

public static string Format<TArg0> (IFormatProvider? provider, System.Text.CompositeFormat format, TArg0 arg0);

Paramètres de type

TArg0

Type du premier objet à mettre en forme.

Paramètres

provider

IFormatProvider

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

format

CompositeFormat

Un CompositeFormat.

arg0

TArg0

Premier objet à mettre en forme.

Retours

String

Chaîne mise en forme.

Exceptions

ArgumentNullException

format est null.

FormatException

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