Informations
Le sujet que vous avez demandé est indiqué ci-dessous. Toutefois, ce sujet ne figure pas dans la bibliothèque.

String.Format, méthode (String, Object[])

Remplace l'élément de mise en forme 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é.

Espace de noms :  System
Assembly :  mscorlib (dans mscorlib.dll)

public static string Format(
	string format,
	params Object[] args
)

Paramètres

format
Type : System.String
Chaîne de format composite (consultez Remarques).
args
Type : System.Object[]
Tableau d'objets contenant aucun ou plusieurs objets à mettre en forme.

Valeur de retour

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

ExceptionCondition
ArgumentNullException

format ou args est null.

FormatException

format n'est pas valide.

ou

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

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 une chaîne. Le .NET Framework assure une prise en charge étendue de la mise en forme, décrite plus en détail dans les rubriques suivantes relatives à la mise en forme :

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

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

{index[,length][:formatString]}

Les éléments entre crochets sont facultatifs. Le tableau suivant décrit les différents éléments. Pour plus d'informations sur la fonctionnalité de mise en forme composite, notamment la syntaxe d'un élément de format, consultez Mise en forme composite.

Élément

Description

index

Position de base zéro dans la liste de paramètres de l'objet à mettre en forme. Si l'objet spécifié par index est null, l'élément de mise en forme est remplacé par String.Empty. S'il n'existe aucun paramètre à la position d'index, une FormatException est levée.

,longueur

Nombre minimal de caractères contenus dans la représentation sous forme de chaîne du paramètre. Si la valeur est positive, le paramètre est aligné à droite ; si la valeur est négative, il est aligné à gauche.

:formatString

Chaîne de format standard ou personnalisée prise en charge par l'objet à mettre en forme. Les valeurs possible pour formatString sont les mêmes que les valeurs prises en charge par la méthode d'objet ToString(format). Si formatString n'est pas spécifié et que l'objet à mettre en forme implémente l'interface IFormattable, null est passée en tant que valeur du paramètre format utilisé en tant que chaîne de format IFormattable.ToString.

RemarqueRemarque

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

Les accolades de début et de fin, « { » et « } » sont obligatoires. Pour spécifier une accolade littérale dans format, entrez deux accolades de début ou de fin ; par exemple, "{{" ou "}}".

Si la valeur de format est « Merci d'avoir acheté {0:####}  copies de Microsoft® .NET (Core Reference). » et arg[0] est un Int16 avec la valeur 123, la valeur de retour sera :

"Merci d'avoir acheté 123 copies de Microsoft® .NET (Core Reference)."

Si la valeur de format est "Le chien de Robert a {0,-8:G} puces." et qu'arg[0] est un Int16 ayant la valeur 42, (et, dans cet exemple, les traits de soulignement représentent les espaces de remplissage), la valeur de retour sera :

"Le chien de Robert a 42______ puces."

L'exemple suivant crée une chaîne qui contient des données sur les températures haute et basse à une date particulière. La chaîne de mise en forme composite a cinq éléments de mise en forme dans l'exemple C# et six dans l'exemple de Visual Basic. Deux des éléments de mise en forme définissent la largeur de la représentation sous forme de chaîne de leur valeur correspondante, et le premier élément de mise en forme inclut également une chaîne de mise en forme des date et heure standard.


using System;

public class Example
{
   public static void Main()
   {
      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 the following output:
//       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)


.NET Framework

Pris en charge dans : 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Pris en charge dans : 4, 3.5 SP1

Pris en charge dans :

Windows 7, Windows Vista SP1 ou ultérieur, Windows XP SP3, Windows XP SP2 Édition x64, Windows Server 2008 (installation minimale non prise en charge), Windows Server 2008 R2 (installation minimale prise en charge avec SP1 ou version ultérieure), Windows Server 2003 SP2

Le .NET Framework ne prend pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.

Ajouts de la communauté

Afficher:
© 2014 Microsoft