示例:WPF中应用DataGrid读取实体DisplayAttribute特性自动自动生成列名

一、目的:通过重写DataGrid的OnAutoGeneratingColumn方法实现根据定义特性自动生成列头信息功能

二、实现

cs 复制代码
<DataGrid ItemsSource="{local:GetStudents Count=50}"/>

实体定义如下

cs 复制代码
 public class Student
 {
     [DataGridColumn("*")]
     [Display(Name = "姓名", GroupName = "基础信息")]
     [Required]
     public string Name { get; set; }

     [DataGridColumn("*")]
     [Display(Name = "班级", GroupName = "基础信息")]
     [Required]
     public string Class { get; set; }

     [DataGridColumn("2*")]
     [Display(Name = "地址", GroupName = "基础信息")]
     [Required]
     public string Address { get; set; }

     [DataGridColumn("2*")]
     [Display(Name = "邮箱", GroupName = "基础信息")]
     [Required]
     public string Emall { get; set; }

     [Display(Name = "可用", GroupName = "其他信息")]
     [Required]
     public bool IsEnbled { get; set; }

     [Display(Name = "时间", GroupName = "其他信息")]
     [Required]
     public DateTime Time { get; set; }

     [Display(Name = "年龄", GroupName = "基础信息")]
     [Required]
     public int Age { get; set; }

     [Display(Name = "分数", GroupName = "成绩信息")]
     public double Score { get; set; }

     [DataGridColumn("2*")]
     [Display(Name = "电话号码", GroupName = "基础信息")]
     [Required]
     [RegularExpression("^1[3|4|5|7|8][0-9]{9}$", ErrorMessage = "手机号码不合法!")]
     public string Tel { get; set; }
 }

通常如上定义会生成一个根据属性名称列头的表格

三、环境

VS2022

四、示例

自定义一个DislayDataGrid,重写OnAutoGeneratingColumn方法

cs 复制代码
    public class DislayDataGrid : DataGrid
    {
        protected override void OnAutoGeneratingColumn(DataGridAutoGeneratingColumnEventArgs e)
        {
            base.OnAutoGeneratingColumn(e);
            if (e.PropertyDescriptor is PropertyDescriptor descriptor)
                e.Column.Header = descriptor.Attributes.OfType<DisplayAttribute>()?.FirstOrDefault().Name;
        }
    }

此时会根据读取特性生成中文名称列头

同理其他属性也可以这样设置

我们扩展一个特性DataGridColumnAttribute

cs 复制代码
    [AttributeUsage(AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
    public class DataGridColumnAttribute : Attribute, IDataGridColumn
    {
        public DataGridColumnAttribute(string width)
        {
            DataGridLengthConverter converter = new DataGridLengthConverter();
            this.Width = (DataGridLength)converter.ConvertFromString(width);
        }
        public DataGridColumnAttribute()
        {

        }
        public DataGridLength Width { get; set; } = DataGridLength.Auto;
        public Type Template { get; set; } = typeof(DataGridTextColumn);
        /// <summary>
        /// "{0}.Property"
        /// </summary>
        public string PropertyPath { get; set; } = "{0}";
        public virtual DataGridColumn GetDataGridColumn(PropertyInfo propertyInfo)
        {
            DataGridColumn dataGridColumn = Activator.CreateInstance(this.Template) as DataGridColumn;
            if (dataGridColumn == null)
            {
                if (propertyInfo.PropertyType == typeof(bool))
                {
                    return new DataGridCheckBoxColumn() { Width = this.Width, IsReadOnly = false };
                }
                else if (propertyInfo.PropertyType.IsEnum)
                {
                    return new DataGridComboBoxColumn() { Width = this.Width, IsReadOnly = false };
                }
                else
                {
                    return new DataGridTextColumn() { Width = this.Width, IsReadOnly = false };
                }
            }
            dataGridColumn.Width = this.Width;
            return dataGridColumn;
        }
    }

在生成列时应用该特性

此时列宽也根据特性变化

如果不想通过自定义DisplayDataGrid实现也可以用Behavior行为的方式实现

实现方式如下:

XML 复制代码
    <DataGrid ItemsSource="{h:GetStudents Count=50}">
        <b:Interaction.Behaviors>
            <h:DataGridAutoColumnBehavior Type="{x:Type h:Student}"/>
        </b:Interaction.Behaviors>
    </DataGrid>

DataGridAutoColumnBehavior的具体实现方式如下

WPF-Control/Source/Extensions/H.Extensions.Behvaiors/DataGrid/DataGridAutoColumnBehavior.cs at main · HeBianGu/WPF-Control · GitHub

这种方式在自动化生成表格数据中非常有用

五、需要了解的知识点

DataGrid.OnAutoGeneratingColumn(DataGridAutoGeneratingColumnEventArgs) 方法 (System.Windows.Controls) | Microsoft Learn

DataGrid 类 (System.Windows.Controls) | Microsoft Learn

六、源码地址

GitHub - HeBianGu/WPF-ControlDemo: 示例

GitHub - HeBianGu/WPF-ControlBase: Wpf封装的自定义控件资源库

GitHub - HeBianGu/WPF-Control: WPF轻量控件和皮肤库

七、了解更多

System.Windows.Controls 命名空间 | Microsoft Learn

https://github.com/HeBianGu

HeBianGu的个人空间-HeBianGu个人主页-哔哩哔哩视频

相关推荐
军训猫猫头8 小时前
5.浏览本地文件获取路径与文件名称 C#例子 WPF例子
开发语言·c#·wpf
步、步、为营15 小时前
.NET + WPF框架开发聊天、网盘、信息发布、视频播放功能
.net·wpf·音视频
code bean1 天前
【WPF实战】MVVM中如何从数据模型反查自定义控件实例(ImageView + Halcon)
wpf
lph19721 天前
ValueConverter转换器WPF
wpf
Sally璐璐1 天前
Memcache核心技术解析与实战应用
运维·wpf·memcached
悟能不能悟1 天前
Dubbo跨越分布式事务的最终一致性陷阱
分布式·wpf·dubbo
I'mSQL1 天前
C#与FX5U进行Socket通信
运维·服务器·自动化·wpf
观无3 天前
关于wpf的自适应
wpf
时光追逐者3 天前
一款开源免费、通用的 WPF 主题控件包
开源·c#·.net·wpf
甜甜不吃芥末3 天前
Windows 应用程序的 UI 框架:WPF、WinUI 3 和 UWP的差异区别
windows·ui·wpf