C#如何获取枚举的描述属性详解

沃梦达教程 C#/.NET开发

2023-01-11

这篇文章主要给大家介绍了关于C#如何获取枚举的描述属性的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧

前言

枚举为我看日常开发的可读性提供的非常好的支持，但是有时在使用枚举类型时，我们需要取名称和值，甚至有时候还需要取枚举类型的描述。通过反射，我们能获取到枚举类型的描述属性。

首先我们需要给枚举类型添加描述属性（属性都没有是不可能取到的），[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，一样可以取到属性。

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对编程学习网的支持。

沃梦达教程

本文标题为：C#如何获取枚举的描述属性详解

上一篇： C#如何给枚举类型增加一个描述特性详解

下一篇： C# 10分钟完成百度人脸识别(入门篇)

基础教程推荐

学习HTML

学习jQuery

学习Laravel

学习CSS3

学习Vue.js

学习Bootstrap5

学习ThinkPHP

学习AJAX