ToString Method

Enum.ToString Method ()


Converts the value of this instance to its equivalent string representation.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

public override string ToString()

Return Value

Type: System.String

The string representation of the value of this instance.

The return value is formatted with the general format specifier ("G"). That is, if the FlagsAttribute is not applied to this enumerated type and there is a named constant equal to the value of this instance, then the return value is a string containing the name of the constant. If the FlagsAttribute is applied and there is a combination of one or more named constants equal to the value of this instance, then the return value is a string containing a delimiter-separated list of the names of the constants. Otherwise, the return value is the string representation of the numeric value of this instance. For more information about formatting enumeration values, see Enumeration Format Strings. For more information about formatting in general, see Formatting Types in the .NET Framework.

Notes to Callers:

If multiple enumeration members have the same underlying value and you attempt to retrieve the string representation of an enumeration member's name based on its underlying value, your code should not make any assumptions about which name the method will return. For example, the following enumeration defines two members, Shade.Gray and Shade.Grey, that have the same underlying value.

public static void TransformFile (XPathNavigator xsltNav) {

 // Load the stylesheet. 
 XslTransform xslt = new XslTransform();
 xslt.Load(xsltNav, null, null);

 // Transform the file.
 xslt.Transform("books.xml", "books.html", null);

The following method call attempts to retrieve the name of a member of the Shade enumeration whose underlying value is 1. The method can return either "Gray" or "Grey", and your code should not make any assumptions about which string will be returned.

string shadeName = ((Shade) 1).ToString();      

The following example demonstrates converting an enumerated value to a string.

public void DisplayOleDbErrorCollection(OleDbException exception)
	for (int i = 0; i < exception.Errors.Count; i++)
		Console.WriteLine("Index #" + i + "\n" +
			"Message: " + exception.Errors[i].Message + "\n" +
			"Native: " + exception.Errors[i].NativeError.ToString() + "\n" +
			"Source: " + exception.Errors[i].Source + "\n" +
			"SQL: " + exception.Errors[i].SQLState + "\n");

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
© 2015 Microsoft