一个可以让你有更多时间摸鱼的WPF控件（二）

佳月金属制品厂

前言
  上文介绍了如何通过一个Form自定义控件来简化数据的录入，并自动实现数据校验，自动布局排列等功能。本文继续介绍如何优化表格控件的使用，缩减代码量，实现工作效率的提升。
一、功能实现
    上文中分析了DataGrid跟ListView两种表格控件的优劣，在这里我们选择ListView来实现我们的表格功能，如有疑问请看上一篇文章，这里不再赘述。
 下面我们定义一个ListViewExtensions静态类来实现ListView的附加属性，并在附加属性更改后实现ListView的优化功能。

1. public static class ListViewExtensions
2.     {
3.         #region AutoGenerateColumns
4.         public static readonly DependencyProperty AutoGenerateColumnsProperty =
5.             DependencyProperty.RegisterAttached("AutoGenerateColumns", typeof(bool), typeof(ListViewExtensions), new PropertyMetadata(false, AutoGenerateColumnsChanged));
7.         public static bool GetAutoGenerateColumns(DependencyObject obj)
8.         {
9.             return (bool)obj.GetValue(AutoGenerateColumnsProperty);
10.         }
12.         public static void SetAutoGenerateColumns(DependencyObject obj, bool value)
13.         {
14.             obj.SetValue(AutoGenerateColumnsProperty, value);
15.         }
17.         private static void AutoGenerateColumnsChanged(DependencyObject obj, DependencyPropertyChangedEventArgs e)
18.         {
19.             ListView listView = obj as ListView;
20.             bool autoGenerateColumns = (bool)e.NewValue;
22.             if (listView != null)
23.             {
24.                 if (autoGenerateColumns)
25.                 {
26.                     listView.Loaded += ListViewLoadedHandler;
28.                 }
29.                 else
30.                 {
31.                     listView.Loaded -= ListViewLoadedHandler;
32.                 }
33.             }
34.         }
36.         private static void ListViewLoadedHandler(object sender, RoutedEventArgs e)
37.         {
38.             var listView = (ListView)sender;
39.             if (listView.ItemsSource == null) return;
41.             var itemType = listView.ItemsSource.GetType().GetGenericArguments().FirstOrDefault();
42.             if (itemType != null)
43.             {
44.                 // 获取数据源的属性信息
45.                 var properties = itemType.GetProperties();
46.                 GridView gridView = null;
47.                 if (listView.View is GridView gv)
48.                 {
49.                     gridView = gv;
50.                 }
51.                 else
52.                 {
53.                     listView.View = gridView = new GridView();
54.                 }
56.                 // 根据属性信息创建列并添加到 GridView 中
57.                 var optionMappingConverter = new OptionMappingConverter();
58.                 var enumDescriptionConverter = new EnumDescriptionConverter();
59.                 foreach (PropertyInfo property in properties)
60.                 {
61.                     //排除无用属性
62.                     var name = property.Name;
63.                     if (PropertyHelper.IgnoredProperties.Contains(property.Name)) continue;
65.                     //读取列参数
66.                     var columnAttribute = property.GetCustomAttributes().OfType<ColumnAttribute>().FirstOrDefault();
67.                     if (columnAttribute == null || !columnAttribute.IsVisible) continue;
69.                     //排除重复属性
70.                     var targetColumn = gridView.Columns.FirstOrDefault(item => GetColumnName(item) == property.Name);
71.                     if (targetColumn != null)
72.                     {
73.                         if (targetColumn.Header == null)
74.                             targetColumn.Header = columnAttribute.Name;
75.                         SetColumnIndex(targetColumn, columnAttribute.Order);
76.                         continue;
77.                     }
79.                     var column = new GridViewColumn() { Header = !string.IsNullOrEmpty(columnAttribute.Name) ? columnAttribute.Name : name };
80.                     SetColumnName(column, property.Name);
81.                     //分组
82.                     if (columnAttribute is GroupColumnAttribute group) ListViewExtensions.SetGroup(column, group.Group);
83.                     //宽度
84.                     if (columnAttribute.Width > 0) column.Width = columnAttribute.Width;
85.                     //转换器
86.                     if (columnAttribute.Converter != null)
87.                     {
88.                         column.DisplayMemberBinding = new Binding(property.Name)
89.                         {
90.                             Converter = Activator.CreateInstance(columnAttribute.Converter) as IValueConverter,
91.                             ConverterParameter = columnAttribute.ConverterParameter,
92.                             StringFormat = columnAttribute.StringFormat
93.                         };
94.                     }
95.                     else
96.                     {
97.                         //指定转换器
98.                         var optionMappingAttribute = property.GetCustomAttributes().OfType<OptionMappingAttribute>().FirstOrDefault();
99.                         if (optionMappingAttribute != null)
100.                         {
101.                             column.DisplayMemberBinding = new Binding(property.Name)
102.                             {
103.                                 Converter = optionMappingConverter,
104.                                 ConverterParameter = optionMappingAttribute.Mapping
105.                             };
106.                         }
107.                         else if (property.PropertyType.IsEnum)
108.                         {
109.                             column.DisplayMemberBinding = new Binding(property.Name)
110.                             {
111.                                 Converter = enumDescriptionConverter,
112.                                 StringFormat = columnAttribute.StringFormat
113.                             };
114.                         }
115.                         else
116.                         {
117.                             column.DisplayMemberBinding = new Binding(property.Name) { StringFormat = columnAttribute.StringFormat };
118.                         }
119.                     }
121.                     SetColumnIndex(column, columnAttribute.Order);
122.                     gridView.Columns.Add(column);
123.                 }
125.                 var cols = gridView.Columns.OrderBy(item => GetColumnIndex(item)).ToArray();
126.                 gridView.Columns.Clear();
127.                 foreach (var col in cols)
128.                 {
129.                     gridView.Columns.Add(col);
130.                 }
131.             }
132.         }
133.         #endregion
135.         #region ColumnIndex
136.         public static int GetColumnIndex(DependencyObject obj)
137.         {
138.             return (int)obj.GetValue(ColumnIndexProperty);
139.         }
141.         public static void SetColumnIndex(DependencyObject obj, int value)
142.         {
143.             obj.SetValue(ColumnIndexProperty, value);
144.         }
146.         public static readonly DependencyProperty ColumnIndexProperty =
147.             DependencyProperty.RegisterAttached("ColumnIndex", typeof(int), typeof(ListViewExtensions), new PropertyMetadata(0));
149.         #endregion
151.         #region ColumnName
152.         public static string GetColumnName(DependencyObject obj)
153.         {
154.             return (string)obj.GetValue(ColumnNameProperty);
155.         }
157.         public static void SetColumnName(DependencyObject obj, string value)
158.         {
159.             obj.SetValue(ColumnNameProperty, value);
160.         }
163.         public static readonly DependencyProperty ColumnNameProperty =
164.             DependencyProperty.RegisterAttached("ColumnName", typeof(string), typeof(ListViewExtensions));
165.         #endregion
167.         #region Group
168.         public static string GetGroup(DependencyObject obj)
169.         {
170.             return (string)obj.GetValue(GroupProperty);
171.         }
173.         public static void SetGroup(DependencyObject obj, string value)
174.         {
175.             obj.SetValue(GroupProperty, value);
176.         }
178.         public static readonly DependencyProperty GroupProperty =
179.             DependencyProperty.RegisterAttached("Group", typeof(string), typeof(ListViewExtensions));
181.         #endregion
182.     }

复制代码

二、示例代码
View

1. [/code][b]Model[/b]
2. [code] public class Person : ValidationObjectBase
3.     {
4.         private string _name;
5.         private DateTime _dateOfBirth = DateTime.Now;
6.         private int _age;
7.         private int _gender = 1;
8.         private string _phoneNumber;
9.         private string _email;
10.         private string _address;
11.         private string _idCardNumber;
12.         private EducationInfo _education;
13.         private MaritalStatus _maritalStatus;
15.         /// <summary>
16.         /// 姓名
17.         /// </summary>
18.         [Column(Name = "姓名", Order = 1)]
19.         public string Name
20.         {
21.             get => _name;
22.             set => this.SetProperty(ref _name, value);
23.         }
25.         /// <summary>
26.         /// 出生日期
27.         /// </summary>
28.         [Column(Name = "出生日期", StringFormat = "{0:yyyy年MM月dd日}", Order = 2)]
29.         public DateTime DateOfBirth
30.         {
31.             get => _dateOfBirth;
32.             set => this.SetProperty(ref _dateOfBirth, value);
33.         }
35.         /// <summary>
36.         /// 年龄
37.         /// </summary>
38.         [Column(Name = "年龄", Order = 3)]
39.         public int Age
40.         {
41.             get => _age;
42.             set => this.SetProperty(ref _age, value);
43.         }
45.         /// <summary>
46.         /// // 性别
47.         /// </summary>
48.         [Column(Name = "性别", Order = 4)]
49.         public int Gender
50.         {
51.             get => _gender;
52.             set => this.SetProperty(ref _gender, value);
53.         }
55.         /// <summary>
56.         /// 手机号码
57.         /// </summary>
58.         [Column(Name = "电话号码", Order = 5)]
59.         public string PhoneNumber
60.         {
61.             get => _phoneNumber;
62.             set => this.SetProperty(ref _phoneNumber, value);
63.         }
65.         /// <summary>
66.         /// 电子邮箱
67.         /// </summary>
68.         [Column(Name = "电子邮箱", Order = 6)]
69.         public string Email
70.         {
71.             get => _email;
72.             set => this.SetProperty(ref _email, value);
73.         }
75.         /// <summary>
76.         /// 地址信息
77.         /// </summary>
78.         [Column(Name = "地址", Order = 7)]
79.         public string Address
80.         {
81.             get => _address;
82.             set => this.SetProperty(ref _address, value);
83.         }
85.         /// <summary>
86.         /// 身份证号码
87.         /// </summary>
88.         [Column(Name = "身份证号码", Order = 8)]
89.         public string IdCardNumber
90.         {
91.             get => _idCardNumber;
92.             set => this.SetProperty(ref _idCardNumber, value);
93.         }
95.         /// <summary>
96.         /// 教育信息
97.         /// </summary>
98.         //[Column(Name = "教育信息", IsVisible = false, Order = 9)]
99.         public EducationInfo Education
100.         {
101.             get => _education;
102.             set => this.SetProperty(ref _education, value);
103.         }
105.         /// <summary>
106.         /// 婚姻状况
107.         /// </summary>
108.         [Column(Name = "婚姻状况", Order = 10)]
109.         public MaritalStatus MaritalStatus
110.         {
111.             get => _maritalStatus;
112.             set => this.SetProperty(ref _maritalStatus, value);
113.         }<br>}

复制代码

ViewModel

1. public class FormDemoViewModel : BindableBase
2.     {
3.         public ObservableCollection<Person> Collection
4.         {
5.             get { return _collection; }
6.             set { this.SetProperty(ref _collection, value); }
7.         }
8.     }

复制代码

 三、答疑解惑
2.1 如何添加自定义列？
答：可以按常规方式添加自定义列，用ListViewExtensions.ColumnIndex来指定位的位置，以下为示例代码。

1. <ListView extensions:ListViewExtensions.AutoGenerateColumns="True" ItemsSource="{Binding Collection}">
2.     <GridView>
3.         <GridViewColumn extensions:ListViewExtensions.ColumnIndex="0">
4.             <GridViewColumn.Header>
5.                 <CheckBox Content="全选" />
6.             </GridViewColumn.Header>
7.             <GridViewColumn.CellTemplate>
8.                 <DataTemplate>
9.                     <CheckBox />
10.                 </DataTemplate>
11.             </GridViewColumn.CellTemplate>
12.         </GridViewColumn>
13.     </GridView>
14. </ListView>

复制代码

2.2 如何自动生成的列不满足需求，可不可以自己定义列？
答：可以，使用ListViewExtensions.ColumnName属性可以覆盖某一个列的自动生成的操作。

1. <ListView extensions:ListViewExtensions.AutoGenerateColumns="True" ItemsSource="{Binding Collection}">
2.     <GridView>
3.         <GridViewColumn
4.                     extensions:ListViewExtensions.ColumnIndex="1"
5.                     extensions:ListViewExtensions.ColumnName="Name">
6.             <GridViewColumn.CellTemplate>
7.                 <DataTemplate>
8.                     <TextBlock Text="{Binding Name}" />
9.                 </DataTemplate>
10.             </GridViewColumn.CellTemplate>
11.         </GridViewColumn>
12.     </GridView>
13. </ListView>

复制代码

2.3 如何给列设置顺序？
答：在属性上给ColumnAttribute特性设置参数Order。

1. [Column(Name = "出生日期", Order = 2)]
2. public DateTime DateOfBirth
3. {
4.       get => _dateOfBirth;
5.       set => this.SetProperty(ref _dateOfBirth, value);
6. }

复制代码

2.4 如何设置列的宽度？
答：在属性上给ColumnAttribute特性设置参数Width。

1. [Column(Name = "出生日期", Width =100)]
2. public DateTime DateOfBirth
3. {
4.       get => _dateOfBirth;
5.       set => this.SetProperty(ref _dateOfBirth, value);
6. }

复制代码

2.5 如何将列设为不可见？
答：在属性上给ColumnAttribute特性设置参数IsVisible。

1. [Column(Name = "出生日期", IsVisible = false)]
2. public DateTime DateOfBirth
3. {
4.        get => _dateOfBirth;
5.        set => this.SetProperty(ref _dateOfBirth, value);
6. }

复制代码

2.6 如何给绑定设置格式化字符串？
答：在属性上给ColumnAttribute特性设置参数StringFormat。

1. [Column(Name = "出生日期", StringFormat = "{0:yyyy年MM月dd日}")]
2. public DateTime DateOfBirth
3. {
4.       get => _dateOfBirth;
5.       set => this.SetProperty(ref _dateOfBirth, value);
6. }

复制代码

2.7 如何给绑定设置转换器及参数？
答：在属性上给ColumnAttribute特性设置Converter和ConverterParameter参数。

1. [Column(Name = "出生日期", Converter = typeof(TestConverter), ConverterParameter=1)]
2. public DateTime DateOfBirth
3. {
4.       get => _dateOfBirth;
5.       set => this.SetProperty(ref _dateOfBirth, value);
6. }

复制代码

 

来源:https://www.cnblogs.com/qushi2020/p/18106033
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！