System.Enum.ToString 方法 (String)

方法描述

使用指定格式将此实例的值转换成其等效的字符串表示。

语法定义(C# System.Enum.ToString 方法 (String) 的用法)

public string ToString(
	string format
)

参数/返回值

参数值/返回值 参数类型/返回类型 参数描述/返回描述
format System-String 格式字符串。
返回值 System.String 此实例的值的字符串表示形式，由 format 指定。

提示和注释

format 参数中可包含格式字符串“G”或“g”、“D”或“d”、“X”或“x”、“F”或“f”。 如果 format 是 null 或空字符串 ("")，则使用一般格式说明符 ("G")。 有关格式化的枚举值的更多信息，请参见 枚举格式字符串. 有关一般格式化的更多信息，请参见格式化类型。

对调用者的说明

如果多个枚举成员具有相同的基础值，且您尝试基于其基础值检索枚举成员名称的字符串表示，则您的代码不做有关该方法将返回哪个姓名的假设。 例如，下列枚举定义了两个具有相同基础值的成员，Shade.Gray 和 Shade.Grey。

C#

VB

复制

enum Shade

{

White = 0, Gray = 1, Grey = 1, Black = 2

}

下面的方法调用尝试检索基础值为 1 的 Shade 枚举成员的名称。 该方法可能返回 "Gray" 或 "Grey"，您的代码不应进行任何有关将返回哪个字符串的假设。

C#

VB

复制

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

System.Enum.ToString 方法 (String)例子

下面的示例演示如何将枚举值转换为字符串。

// Sample for Enum.ToString(String)
using System;

class Sample 
{
    enum Colors {Red, Green, Blue, Yellow = 12};

    public static void Main() 
    {
    Colors myColor = Colors.Yellow;

    Console.WriteLine("Colors.Red = {0}", Colors.Red.ToString("d"));
    Console.WriteLine("Colors.Green = {0}", Colors.Green.ToString("d"));
    Console.WriteLine("Colors.Blue = {0}", Colors.Blue.ToString("d"));
    Console.WriteLine("Colors.Yellow = {0}", Colors.Yellow.ToString("d"));

    Console.WriteLine("{0}myColor = Colors.Yellow{0}", Environment.NewLine);

    Console.WriteLine("myColor.ToString(\"g\") = {0}", myColor.ToString("g"));
    Console.WriteLine("myColor.ToString(\"G\") = {0}", myColor.ToString("G"));

    Console.WriteLine("myColor.ToString(\"x\") = {0}", myColor.ToString("x"));
    Console.WriteLine("myColor.ToString(\"X\") = {0}", myColor.ToString("X"));

    Console.WriteLine("myColor.ToString(\"d\") = {0}", myColor.ToString("d"));
    Console.WriteLine("myColor.ToString(\"D\") = {0}", myColor.ToString("D"));    

    Console.WriteLine("myColor.ToString(\"f\") = {0}", myColor.ToString("f"));
    Console.WriteLine("myColor.ToString(\"F\") = {0}", myColor.ToString("F"));
    }
}
/*
This example produces the following results:
Colors.Red = 0
Colors.Green = 1
Colors.Blue = 2
Colors.Yellow = 12

myColor = Colors.Yellow

myColor.ToString("g") = Yellow
myColor.ToString("G") = Yellow
myColor.ToString("x") = 0000000C
myColor.ToString("X") = 0000000C
myColor.ToString("d") = 12
myColor.ToString("D") = 12
myColor.ToString("f") = Yellow
myColor.ToString("F") = Yellow
*/

异常

异常 异常描述
FormatException format 包含无效规范。
InvalidOperationException format 等于“X”，但枚举类型未知。

命名空间

namespace: System

程序集: mscorlib（在 mscorlib.dll 中）

版本信息

.NET Framework 受以下版本支持：4、3.5、3.0、2.0、1.1、1.0 .NET Framework Client Profile 受以下版本支持：4、3.5 SP1 受以下版本支持：

适用平台

Windows 7, Windows Vista SP1 或更高版本, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008（不支持服务器核心）, Windows Server 2008 R2（支持 SP1 或更高版本的服务器核心）, Windows Server 2003 SP2 .NET Framework 并不是对每个平台的所有版本都提供支持。有关支持的版本的列表，请参见.NET Framework 系统要求。

相关资源

Enum 类
ToString 重载
System 命名空间
Format
Parse
ToString
格式化类型
枚举格式字符串
MSDN