Enumeration Format Strings
Microsoft Silverlight will reach end of support after October 2021. Learn more.
You can use the Enum.ToString method to create a new string object that represents the numeric, hexadecimal, or string value of an enumeration member. This method takes one of the enumeration formatting strings to specify the value that you want returned.
The following table lists the enumeration formatting strings and the values they return. These format specifiers are not case-sensitive.
Format string |
Result |
|---|---|
G or g |
Displays the enumeration entry as a string value, if possible, and otherwise displays the integer value of the current instance. If the enumeration is defined with the Flags attribute set, the string values of each valid entry are concatenated together, separated by commas. If the Flags attribute is not set, an invalid value is displayed as a numeric entry. The following example illustrates the G format specifier. |
F or f |
Displays the enumeration entry as a string value, if possible. If the value can be completely displayed as a summation of the entries in the enumeration (even if the Flags attribute is not present), the string values of each valid entry are concatenated together, separated by commas. If the value cannot be completely determined by the enumeration entries, then the value is formatted as the integer value. The following example illustrates the F format specifier. |
D or d |
Displays the enumeration entry as an integer value in the shortest representation possible. The following example illustrates the D format specifier. |
X or x |
Displays the enumeration entry as a hexadecimal value. The value is represented with leading zeros as necessary, to ensure that the value is a minimum eight digits in length. The following example illustrates the X format specifier. |
Example
The following example defines an enumeration called Colors that consists of three entries: Red, Blue, and Green.
Public Enum Color
Red = 1
Blue = 2
Green = 3
End Enum
public enum Color { Red = 1, Blue = 2, Green = 3 }
After the enumeration is defined, an instance can be declared in the following manner.
Dim myColor As Color = Color.Green
Color myColor = Color.Green;
The Color.ToString(System.String) method can then be used to display the enumeration value in different ways, depending on the format specifier passed to it.
outputBlock.Text += String.Format("The value of myColor is {0}.", _
myColor.ToString("G")) & vbCrLf
outputBlock.Text += String.Format("The value of myColor is {0}.", _
myColor.ToString("F")) & vbCrLf
outputBlock.Text += String.Format("The value of myColor is {0}.", _
myColor.ToString("D")) & vbCrLf
outputBlock.Text += String.Format("The value of myColor is 0x{0}.", _
myColor.ToString("X")) & vbCrLf
' The example displays the following output:
' The value of myColor is Green.
' The value of myColor is Green.
' The value of myColor is 3.
' The value of myColor is 0x00000003.
outputBlock.Text += String.Format("The value of myColor is {0}.",
myColor.ToString("G")) + "\n";
outputBlock.Text += String.Format("The value of myColor is {0}.",
myColor.ToString("F")) + "\n";
outputBlock.Text += String.Format("The value of myColor is {0}.",
myColor.ToString("D")) + "\n";
outputBlock.Text += String.Format("The value of myColor is 0x{0}.",
myColor.ToString("X")) + "\n";
// The example displays the following output:
// The value of myColor is Green.
// The value of myColor is Green.
// The value of myColor is 3.
// The value of myColor is 0x00000003.