Chaînes de format d'énumération

  • Article

Vous pouvez utiliser la méthode Enum.ToString pour créer un nouvel objet chaîne qui représente la valeur numérique, hexadécimale ou de chaîne d'un membre de l'énumération. Cette méthode prend une des chaînes de format d'énumération pour spécifier la valeur à retourner.

Le tableau suivant répertorie les chaînes de format d'énumération et les valeurs qu'elles retournent. Ces spécificateurs de format ne respectent pas la casse.

Chaîne de format

Résultat

G ou g

Affiche l'entrée d'énumération sous la forme d'une valeur de chaîne dans la mesure du possible ; sinon, affiche la valeur entière de l'instance actuelle. Si l'énumération est configurée et si l'attribut Flags est défini, les valeurs de chaîne de chaque entrée valide sont concaténées ensemble, séparées par des virgules. Si l'attribut Flags n'est pas défini, une valeur non valide s'affiche comme entrée numérique. L'exemple suivant illustre le spécificateur de format G.

F ou f

Affiche, dans la mesure du possible, l'entrée d'énumération en tant que valeur de chaîne. Si la valeur peut être complètement affichée en tant que somme des entrées de l'énumération (même en cas d'absence de l'attribut Flags), les valeurs de chaîne de chaque entrée valide sont concaténées ensemble, séparées par des virgules. Si la valeur ne peut pas être complètement déterminée par les entrées de l'énumération, la valeur est mise en forme en tant que valeur entière. L'exemple suivant illustre le spécificateur de format F.

D ou d

Affiche l'entrée d'énumération sous la forme d'une valeur entière dans la plus courte représentation possible. L'exemple suivant illustre le spécificateur de format D.

X ou x

Affiche l'entrée d'énumération sous la forme d'une valeur hexadécimale. La valeur est représentée avec des zéros à gauche le cas échéant, pour garantir que la valeur comprend au moins huit chiffres. L'exemple suivant illustre le spécificateur de format X.

Exemple

L'exemple suivant définit une énumération appelée Colors qui se compose de trois entrées : Red, Blue et Green.

Public Enum Color
   Red = 1
   Blue = 2
   Green = 3
End Enum

public enum Color {Red = 1, Blue = 2, Green = 3}

Une fois l'énumération définie, une instance peut être déclarée de la manière suivante.

Dim myColor As Color = Color.Green      

Color myColor = Color.Green;

La méthode Color.ToString(System.String) peut ensuite être utilisée pour afficher la valeur d'énumération de différentes façons, selon le spécificateur de format qui lui est passé.

Console.WriteLine("The value of myColor is {0}.", _
                  myColor.ToString("G"))
Console.WriteLine("The value of myColor is {0}.", _
                  myColor.ToString("F"))
Console.WriteLine("The value of myColor is {0}.", _
                  myColor.ToString("D"))
Console.WriteLine("The value of myColor is 0x{0}.", _
                  myColor.ToString("X"))
' The example displays the following output to the console:
'       The value of myColor is Green.
'       The value of myColor is Green.
'       The value of myColor is 3.
'       The value of myColor is 0x00000003.      

Console.WriteLine("The value of myColor is {0}.", 
                  myColor.ToString("G"));
Console.WriteLine("The value of myColor is {0}.", 
                  myColor.ToString("F"));
Console.WriteLine("The value of myColor is {0}.", 
                  myColor.ToString("D"));
Console.WriteLine("The value of myColor is 0x{0}.", 
                  myColor.ToString("X"));
// The example displays the following output to the console:
//       The value of myColor is Green.
//       The value of myColor is Green.
//       The value of myColor is 3.
//       The value of myColor is 0x00000003.

Voir aussi

Concepts

Mise en forme des types