System.Enum.ToString 方法

方法描述

将此实例的值转换为其等效的字符串表示形式。

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

public override string ToString()

参数/返回值

参数值/返回值 参数类型/返回类型 参数描述/返回描述
返回值 System.String 此实例的值的字符串表示。

提示和注释

返回值由通用格式说明符("G")进行格式设置。 也就是说,如果未将 FlagsAttribute 应用到此枚举类型,且存在与此实例的值相等的已命名常数,则返回值为包含该常数名称的字符串。 如果应用了 FlagsAttribute,且存在与此实例的值相等的一个或多个已命名常数的组合,则返回值是一个字符串,该字符串包含用分隔符分隔的常数名称列表。 其他情况下,返回值是此实例的数值的字符串表示形式。 有关格式化的枚举值的更多信息,请参见 枚举格式字符串. 有关一般格式化的更多信息,请参见格式化类型。

对调用者的说明

如果多个枚举成员具有相同的基础值,且您尝试基于其基础值检索枚举成员名称的字符串表示,则您的代码不做有关该方法将返回哪个姓名的假设。 例如,下列枚举定义了两个具有相同基础值的成员,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();

System.Enum.ToString 方法例子

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

using System;

public class EnumSample {
    enum Colors {Red = 1, Blue = 2};

    public static void Main() {
        Enum myColors = Colors.Red;
        Console.WriteLine("The value of this instance is '{0}'",
           myColors.ToString());
    }
}
/*
Output.
The value of this instance is 'Red'.
*/

异常

异常 异常描述

命名空间

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 系统要求。