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#重写DataGridView

    C#重写DataGridView

    这篇文章主要为大家详细介绍了C#重写DataGridView的相关资料,感兴趣的小伙伴们可以参考一下
    2016-05-05
  • C#使用RegNotifyChangeKeyValue监听注册表更改的方法小结

    C#使用RegNotifyChangeKeyValue监听注册表更改的方法小结

    RegNotifyChangeKeyValue的最后一个参数传递false,表示以同步的方式监听,这篇文章主要介绍了C#使用RegNotifyChangeKeyValue监听注册表更改的方法小结,需要的朋友可以参考下
    2024-06-06
  • C# 线程安全详解

    C# 线程安全详解

    这篇文章主要介绍了c# 线程安全的用法原理及使用示例,帮助大家更好的理解和使用c#,感兴趣的朋友可以了解下,希望能够给你带来帮助
    2021-09-09
  • C#实现TIF图像转PDF文件的方法

    C#实现TIF图像转PDF文件的方法

    这篇文章主要介绍了C#实现TIF图像转PDF文件的方法,涉及C#使用TIFtoPDF工具实现pdf文件转换的技巧,需要的朋友可以参考下
    2015-07-07
  • C#中Winform窗体Form的关闭按钮变灰色的方法

    C#中Winform窗体Form的关闭按钮变灰色的方法

    这篇文章主要介绍了C#中Winform窗体Form的关闭按钮变灰色的方法,对于C#程序界面的设计有一定的借鉴价值,需要的朋友可以参考下
    2014-08-08
  • c#编写webservice服务引用实例分享

    c#编写webservice服务引用实例分享

    c#编写webservice服务引用实例分享,大家参考使用吧
    2013-12-12
  • C#图片处理类分享

    C#图片处理类分享

    这篇文章主要为大家分享了C#图片处理类的相关代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-06-06
  • 在C#中实现接口事件的具体示例

    在C#中实现接口事件的具体示例

    在C#中,接口(interface)是一种定义类必须实现的方法和属性的抽象类型,除了方法和属性,接口还可以包含事件,实现接口事件可以帮助我们设计更加灵活和解耦的系统,本文将详细探讨如何在C#中实现接口事件,并通过具体示例说明其应用,需要的朋友可以参考下
    2024-08-08
  • C#事件处理和委托event delegate实例简述

    C#事件处理和委托event delegate实例简述

    这篇文章主要介绍了C#事件处理和委托event delegate的简单实例,较为详细的讲述了C#事件处理和委托的声明与实现过程,代码简单易懂,需要的朋友可以参考下
    2014-09-09
  • C# wpf利用附加属性实现界面上定义装饰器

    C# wpf利用附加属性实现界面上定义装饰器

    装饰器是wpf中可以浮在控件上面的一种组件,我们通常可以用来实现一些诸如控件拖动点、提示框、自定义鼠标等界面功能。本文主要是利用附加属性实现界面上定义装饰器,需要的可以参考下
    2022-12-12

最新评论