C# 获取枚举的描述属性

最新推荐文章于 2024-07-17 17:09:29 发布

转载最新推荐文章于 2024-07-17 17:09:29 发布 · 184 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：http://www.cnblogs.com/TanSea/p/Enum-Description.html

文章标签：

#c#

本文介绍了如何在C#中为枚举类型添加描述属性，并通过反射获取这些描述。通过实例展示了如何使用[Description]属性和自定义方法GetEnumDescription来获取枚举项的描述。

在使用枚举类型时，我们需要取名称和值，甚至有时候还需要取枚举类型的描述。通过反射，我们能获取到枚举类型的描述属性。

首先我们需要给枚举类型添加描述属性（属性都没有是不可能取到的），[Description]就是描述属性，使用这个属性，我们需要添加 using System.ComponentModel 引用。

public enum EnumSex
{
    /// <summary>
    /// 男
    /// </summary>
    [Description("男")]
    Male = 0,
    /// <summary>
    /// 女
    /// </summary>
    [Description("女")]
    Female = 1
}

接着我们需要写一个获取描述属性的方法，FieldInfo需要添加 using System.Reflection 引用，DescriptionAttribute需要添加 using System.ComponentModel 引用。

public string GetEnumDescription(Enum enumValue)
{
    string value = enumValue.ToString();
    FieldInfo field = enumValue.GetType().GetField(value);
    object[] objs = field.GetCustomAttributes(typeof(DescriptionAttribute), false);    //获取描述属性
    if (objs == null || objs.Length == 0)    //当描述属性没有时，直接返回名称
        return value;
    DescriptionAttribute descriptionAttribute = (DescriptionAttribute)objs[0];
    return descriptionAttribute.Description;
}

好了，现在我们可以获取到枚举的描述了。

string sex = GetEnumDescription(EnumSex.Female);    //sex = "女"

同理，我们可以给枚举类型赋上其他类型的属性，比如Obsolete，在GetEnumDescription方法里面将DescriptionAttribute换成ObsoleteAttribute，一样可以取到属性。

转载于:https://www.cnblogs.com/TanSea/p/Enum-Description.html