C#获取Description特性的扩展类详解

 更新时间:2022年06月24日 08:19:36   作者:time-flies  
这篇文章主要和大家详细介绍一下C#获取Description特性的扩展类,文中的示例代码讲解详细,对我们学习有一定的帮助,需要的可以参考一下

C#中Description特性主要用于枚举和属性,方法比较简单,记录一下以便后期使用。

扩展类DescriptionExtension代码如下:

using System;
using System.ComponentModel;
using System.Reflection;
 
/// <summary>
/// 描述特性的读取扩展类
/// </summary>
public static class DescriptionExtension
{
    /// <summary>
    /// 获取枚举的描述信息
    /// </summary>
    public static string GetDescription(this Enum em)
    {
        Type type = em.GetType();
        FieldInfo fd = type.GetField(em.ToString());
        string des = fd.GetDescription();
        return des;
    }



    /// <summary>
    /// 获取属性的描述信息
    /// </summary>
    public static string GetDescription(this Type type, string proName)
    {
        PropertyInfo pro = type.GetProperty(proName);
        string des = proName;
        if (pro != null)
        {
            des = pro.GetDescription();
        }
        return des;
    }



    /// <summary>
    /// 获取属性的描述信息
    /// </summary>
    public static string GetDescription(this MemberInfo info)
    {
        var attrs = (DescriptionAttribute[])info.GetCustomAttributes(typeof(DescriptionAttribute), false);
        string des = info.Name;
        foreach (DescriptionAttribute attr in attrs)
        {
            des = attr.Description;
        }
        return des;
    }
}

使用方法:

[Description("测试枚举名")]
enum TestEnum 
{
    [Description("测试")]
    Test1 
}

[Description("测试类名")]
class TestClass
{
    [Description("测试class")]
    public int Test1 { get; set; }
}

//获取枚举类型的描述特性
string str1 = typeof(TestEnum).GetDescription();

//获取枚举值的描述特性
string str2 =TestEnum.Test1.GetDescription();
str2 = typeof(TestEnum).GetDescription(nameof(TestEnum.Test1));
str2 = typeof(TestEnum).GetDescription(TestEnum.Test1.ToString());

//获取类的描述特性
string str3 = typeof(TestClass).GetDescription();

//获取属性的描述特性(也可以反射遍历属性列表)
string str4 = typeof(TestClass).GetDescription();
TestClass test = new TestClass();
str4 = typeof(TestClass).GetDescription(nameof(test.Test1));

补充:

C#利用扩展方法获得枚举的Description

/// <summary>
/// 扩展方法,获得枚举的Description
/// </summary>
/// <param name="value">枚举值</param>
/// <param name="nameInstead">当枚举值没有定义DescriptionAttribute,是否使用枚举名代替,默认是使用</param>
/// <returns>枚举的Description</returns>
public static string GetDescription(this Enum value, Boolean nameInstead = true)
{
    Type type = value.GetType();
    string name = Enum.GetName(type, value);
    if (name == null)
    {
        return null;
    }
  
    FieldInfo field = type.GetField(name);
    DescriptionAttribute attribute = System.Attribute.GetCustomAttribute(field, typeof(DescriptionAttribute)) as DescriptionAttribute;
  
    if (attribute == null && nameInstead == true)
    {
        return name;
    }
    return attribute?.Description;
}

随便整一个枚举

public enum ModuleType
 {
     /// <summary>
     /// 中国
     /// </summary>
     [Description("中国")]
     ZH = 1,
     /// <summary>
     /// 美国
     /// </summary>
     [Description("美国")]
     MG = 2
 }

到此这篇关于C#获取Description特性的扩展类详解的文章就介绍到这了,更多相关C#获取Description特性内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • c# 委托和事件实例学习

    c# 委托和事件实例学习

    今天把委托和事件研究了一个,winForm环境下,一般的小例子都是字符界面,我为了运用一下,写了winForm
    2009-01-01
  • C#特性(Attribute)

    C#特性(Attribute)

    这篇文章介绍了C#的特性(Attribute),文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-03-03
  • C#处理JPEG头信息的方法

    C#处理JPEG头信息的方法

    相信大家肯定都看过用C或C++处理JPEG头信息的程序了,我也看了,不过因为我不懂C,看得我头疼。所以我还是决定用C#来写吧
    2013-05-05
  • C#新手常犯的错误汇总

    C#新手常犯的错误汇总

    这篇文章主要介绍了C#新手常犯的错误汇总,对于经验丰富的C#程序员同样具有很好的参考借鉴价值,需要的朋友可以参考下
    2014-08-08
  • Unity实现简单的多人聊天工具

    Unity实现简单的多人聊天工具

    这篇文章主要为大家详细介绍了Unity实现简单的多人聊天工具,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-02-02
  • C#线程委托BeginInvoke与EndInvoke的用法

    C#线程委托BeginInvoke与EndInvoke的用法

    这篇文章介绍了C#线程委托BeginInvoke与EndInvoke的用法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-07-07
  • C#遍历DataSet控件实例总结

    C#遍历DataSet控件实例总结

    这篇文章主要介绍了C#遍历DataSet控件的用法,以实例形式总结归纳了常见的遍历方法,具有一定的参考学习价值,需要的朋友可以参考下
    2014-10-10
  • C#开发教程之FTP上传下载功能详解

    C#开发教程之FTP上传下载功能详解

    这篇文章主要为大家详细介绍了C#开发教程之FTP上传下载功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-04-04
  • C#使用JArray和JObject封装JSON对象

    C#使用JArray和JObject封装JSON对象

    这篇文章介绍了C#使用JArray和JObject封装JSON对象的方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-07-07
  • js substr,substring与java substring和C# substring的区别解析

    js substr,substring与java substring和C# substring的区别解析

    本篇文章主要是对js中substr,substring与java中substring和C#中substring的区别进行了介绍,需要的朋友可以过来参考下,希望对大家有所帮助
    2014-01-01

最新评论