浅谈WPF之属性系统

风之猎手

在WPF开发中，经常听到各种属性，如：依赖属性，附加属性，CLR属性，那这些不同类型的属性，具体又有什么作用呢？今天以一些简单的小例子，简述一下WPF开发中，各种属性的相关概念和应用，仅供学习分享使用，如有不足之处，还请指正。

 
CLR属性

 
CLR属性（Common Language Runtime），又称为.Net 标准属性，是对类中私有字段（private）的安装访问包装。通过属性，可以对调用对象输入的值进行校验，拦截等。
在属性出现之前，如果要对公开字段进行内容校验，则需要通过公开的方法进行调用，而且无法进行强制性校验，这样增加了数据校验的难度和程序的复杂度。具体代码如下所示：

1. public class Person
2. {
3.         /// <summary>
4.         /// 私有字段
5.         /// </summary>
6.         private int id = 0;
8.         /// <summary>
9.         /// 公共字段
10.         /// </summary>
11.         public string Name = "Alan";
13.         /// <summary>
14.         /// 字段校验函数
15.         /// </summary>
16.         /// <param name="name"></param>
17.         /// <returns></returns>
18.         public bool SetName(string name)
19.         {
20.                 if (string.IsNullOrEmpty(name) || name == "Admin")
21.                 {
22.                         return false;
23.                 }
24.                 this.Name = name;
25.                 return true;
26.         }
28.         public void Do()
29.         {
30.                 //在此示例中，Name的值，可通过公共字段进行赋值，也可通过SetName方法赋值，但是我们无法要求调用对象强制采用哪一种，，因为看起来两种都可以。
31.                 Console.WriteLine($"Name={this.Name}");
32.         }
33. }

复制代码

注意：在此示例中，Name的值，可通过公共字段进行赋值，也可通过SetName方法赋值，但是我们无法要求调用对象强制采用哪一种，，因为看起来两种都可以。
在引入了属性概念以后，则可以很方便的解决些问题，程序本身看起来也会变得整洁，如下所示：

1. public class Person
2. {
3.         private string name =String.Empty;
4.         /// <summary>
5.         /// 属性
6.         /// </summary>
7.         public string Name {
8.                 get { return name; }
9.                 set
10.                 {
11.                         if (string.IsNullOrEmpty(value) || value == "Admin")
12.                         {
13.                                 return;
14.                         }
15.                         name = value;
16.                 }
17.         }
19.         public void Do()
20.         {
21.                 //引入属性后，可以在属性的set方法中进行校验。
22.                 Console.WriteLine($"Name={this.Name}");
23.         }
24. }

复制代码

通过程序对比发现，属性封装了对私有字段的安全访问，等于在字段外增加了一层防护膜，且简化了程序，使得程序看起来更加简洁明了。
 
依赖属性

 
在WPF中，微软将属性这个概念又向前推进了一步，推出了“依赖属性”这个新概念。那什么是依赖属性呢？
简言之，依赖属性就是一种可以自己没有值，并能通过使用Binding 从数据源获得值(依赖在别人身上)的属性。拥有依赖属性的对象被称为“依赖对象”。
依赖属性相关概念和术语，如下所示：

• 依赖属性：DependencyProperty 支持的属性。
  
• 依赖属性标识符：一个 DependencyProperty 实例，在注册依赖属性时以返回值形式获取它，之后将其存储为类的静态成员。 对于与 WPF 属性系统交互的许多 API，此标识符用作一个参数。
  
• CLR“包装器”：属性的实际 get 和 set 实现。 这些实现通过在 GetValue 和 SetValue 调用中使用依赖属性标识符来并入依赖属性标识符，从而使用 WPF 属性系统为属性提供支持。
  

依赖属性的创建示例，如下所示：

1. public partial class Test : UserControl
2. {
3.         public int Age
4.         {
5.                 get { return (int)GetValue(AgeProperty); }
6.                 set { SetValue(AgeProperty, value); }
7.         }
9.         public static readonly DependencyProperty AgeProperty =
10.                 DependencyProperty.Register("Age", typeof(int), typeof(Test), new PropertyMetadata(0, AgeChangedCallBack));
13.         private static void AgeChangedCallBack(DependencyObject d, DependencyPropertyChangedEventArgs e)
14.         {
15.                 //处理变更后的逻辑
16.                 var test = d as Test;
17.                 var newValue = e.NewValue;
18. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
19.     <TextBlock localView:Test.Distance="10"></TextBlock>
20. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
21.     <TextBlock localView:Test.Distance="10"></TextBlock>
22. </localView:Test>test.txtAge.Text = newValue.ToString();
23.         }
25.         public Test()
26.         {
27.                 InitializeComponent();
28.         }
29. }

复制代码

在Test.xaml中代码如下所示：

1. <UserControl x:
2. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
3.     <TextBlock localView:Test.Distance="10"></TextBlock>
4. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
5.     <TextBlock localView:Test.Distance="10"></TextBlock>
6. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
7.     <TextBlock localView:Test.Distance="10"></TextBlock>
8. </localView:Test> xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
9. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
10.     <TextBlock localView:Test.Distance="10"></TextBlock>
11. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
12.     <TextBlock localView:Test.Distance="10"></TextBlock>
13. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
14.     <TextBlock localView:Test.Distance="10"></TextBlock>
15. </localView:Test> xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
16. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
17.     <TextBlock localView:Test.Distance="10"></TextBlock>
18. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
19.     <TextBlock localView:Test.Distance="10"></TextBlock>
20. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
21.     <TextBlock localView:Test.Distance="10"></TextBlock>
22. </localView:Test> xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
23. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
24.     <TextBlock localView:Test.Distance="10"></TextBlock>
25. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
26.     <TextBlock localView:Test.Distance="10"></TextBlock>
27. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
28.     <TextBlock localView:Test.Distance="10"></TextBlock>
29. </localView:Test> xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
30. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
31.     <TextBlock localView:Test.Distance="10"></TextBlock>
32. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
33.     <TextBlock localView:Test.Distance="10"></TextBlock>
34. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
35.     <TextBlock localView:Test.Distance="10"></TextBlock>
36. </localView:Test> xmlns:local="clr-namespace:DemoMVVM.Views"
37. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
38.     <TextBlock localView:Test.Distance="10"></TextBlock>
39. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
40.     <TextBlock localView:Test.Distance="10"></TextBlock>
41. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
42.     <TextBlock localView:Test.Distance="10"></TextBlock>
43. </localView:Test> mc:Ignorable="d"
44. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
45.     <TextBlock localView:Test.Distance="10"></TextBlock>
46. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
47.     <TextBlock localView:Test.Distance="10"></TextBlock>
48. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
49.     <TextBlock localView:Test.Distance="10"></TextBlock>
50. </localView:Test> d:DesignHeight="450" d:DesignWidth="800">
51. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
52.     <TextBlock localView:Test.Distance="10"></TextBlock>
53. </localView:Test><Grid>
54. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
55.     <TextBlock localView:Test.Distance="10"></TextBlock>
56. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
57.     <TextBlock localView:Test.Distance="10"></TextBlock>
58. </localView:Test><StackPanel Orientation="Vertical">
59. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
60.     <TextBlock localView:Test.Distance="10"></TextBlock>
61. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
62.     <TextBlock localView:Test.Distance="10"></TextBlock>
63. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
64.     <TextBlock localView:Test.Distance="10"></TextBlock>
65. </localView:Test><TextBlock Text="年龄：" FontSize="14"></TextBlock>
66. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
67.     <TextBlock localView:Test.Distance="10"></TextBlock>
68. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
69.     <TextBlock localView:Test.Distance="10"></TextBlock>
70. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
71.     <TextBlock localView:Test.Distance="10"></TextBlock>
72. </localView:Test><TextBox x:Name="txtAge" Height="30" Width="150" HorizontalAlignment="Left" VerticalContentAlignment="Center" FontSize="14"></TextBox>
73. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
74.     <TextBlock localView:Test.Distance="10"></TextBlock>
75. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
76.     <TextBlock localView:Test.Distance="10"></TextBlock>
77. </localView:Test></StackPanel>
78. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
79.     <TextBlock localView:Test.Distance="10"></TextBlock>
80. </localView:Test></Grid>
81. </UserControl>

复制代码

当依赖属性创建完成后，可以在调用的地方，进行赋值或者进行Binding其他依赖属性，如下所示：

1. <UserControl x:
2. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
3.     <TextBlock localView:Test.Distance="10"></TextBlock>
4. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
5.     <TextBlock localView:Test.Distance="10"></TextBlock>
6. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
7.     <TextBlock localView:Test.Distance="10"></TextBlock>
8. </localView:Test> xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
9. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
10.     <TextBlock localView:Test.Distance="10"></TextBlock>
11. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
12.     <TextBlock localView:Test.Distance="10"></TextBlock>
13. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
14.     <TextBlock localView:Test.Distance="10"></TextBlock>
15. </localView:Test> xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
16. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
17.     <TextBlock localView:Test.Distance="10"></TextBlock>
18. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
19.     <TextBlock localView:Test.Distance="10"></TextBlock>
20. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
21.     <TextBlock localView:Test.Distance="10"></TextBlock>
22. </localView:Test> xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
23. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
24.     <TextBlock localView:Test.Distance="10"></TextBlock>
25. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
26.     <TextBlock localView:Test.Distance="10"></TextBlock>
27. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
28.     <TextBlock localView:Test.Distance="10"></TextBlock>
29. </localView:Test> xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
30. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
31.     <TextBlock localView:Test.Distance="10"></TextBlock>
32. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
33.     <TextBlock localView:Test.Distance="10"></TextBlock>
34. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
35.     <TextBlock localView:Test.Distance="10"></TextBlock>
36. </localView:Test> xmlns:local="clr-namespace:DemoMVVM.Views"
37. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
38.     <TextBlock localView:Test.Distance="10"></TextBlock>
39. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
40.     <TextBlock localView:Test.Distance="10"></TextBlock>
41. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
42.     <TextBlock localView:Test.Distance="10"></TextBlock>
43. </localView:Test> mc:Ignorable="d"
44. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
45.     <TextBlock localView:Test.Distance="10"></TextBlock>
46. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
47.     <TextBlock localView:Test.Distance="10"></TextBlock>
48. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
49.     <TextBlock localView:Test.Distance="10"></TextBlock>
50. </localView:Test> d:DesignHeight="450" d:DesignWidth="800">
51. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
52.     <TextBlock localView:Test.Distance="10"></TextBlock>
53. </localView:Test><Grid>
54. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
55.     <TextBlock localView:Test.Distance="10"></TextBlock>
56. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
57.     <TextBlock localView:Test.Distance="10"></TextBlock>
58. </localView:Test><StackPanel Orientation="Vertical">
59. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
60.     <TextBlock localView:Test.Distance="10"></TextBlock>
61. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
62.     <TextBlock localView:Test.Distance="10"></TextBlock>
63. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
64.     <TextBlock localView:Test.Distance="10"></TextBlock>
65. </localView:Test><TextBlock Text="年龄：" FontSize="14"></TextBlock>
66. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
67.     <TextBlock localView:Test.Distance="10"></TextBlock>
68. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
69.     <TextBlock localView:Test.Distance="10"></TextBlock>
70. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
71.     <TextBlock localView:Test.Distance="10"></TextBlock>
72. </localView:Test><TextBox x:Name="txtAge" Height="30" Width="150" HorizontalAlignment="Left" VerticalContentAlignment="Center" FontSize="14"></TextBox>
73. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
74.     <TextBlock localView:Test.Distance="10"></TextBlock>
75. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
76.     <TextBlock localView:Test.Distance="10"></TextBlock>
77. </localView:Test></StackPanel>
78. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
79.     <TextBlock localView:Test.Distance="10"></TextBlock>
80. </localView:Test></Grid>
81. </UserControl><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
82.     <TextBlock localView:Test.Distance="10"></TextBlock>
83. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
84.     <TextBlock localView:Test.Distance="10"></TextBlock>
85. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
86.     <TextBlock localView:Test.Distance="10"></TextBlock>
87. </localView:Test><localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
88.     <TextBlock localView:Test.Distance="10"></TextBlock>
89. </localView:Test>

复制代码

在上述示例中，将依赖属性Age绑定到Slider，通过Slider控件的滑动，数值改变，触发Age属性的回调函数。

在Visual Studio开发工具中，创建依赖属性可通过模板进行创建。输入propd，然后tab键即可完成一个int类型的依赖属性创建。
如果需要新增代码片段模板，可以在Visual Studio中，工具菜单--代码片段管理器，打开代码片段管理窗口，然后选择CSharp，如下所示：

通过代码片段管理器，可以查看快捷方式和片段存储位置，修改后自动生效。如下所示：

 与传统的CLR属性和面向对象思想相比依赖属性有很多新颖之处，其中包括：
（1）节省实例对内存的开销。
（2）属性值可以通过Binding依赖在其他对象上。
 
附加属性

 
顾名思义，附加属性是说一个属性本来不属于某个对象，但由于某种需求而被后来附加上。也就是把对象放入一个特定环境后对象才具有的属性(表现出来就是被环培赋予的属性）就称为附加属性（(Attached Properties)。
例如：放在Grid里就让Grid为它附加上 Column和Row属性，放在Canvas里就让Canvas为它附加上Top、Left等属性，放在 DockPanel里就让DockPanel 为它附加Dock属性。可见，附加属性的作用就是将属性与数据类型(宿主）解耦，让数据类型的设计更加灵活。
附加属性创建语法：

1. public static int GetDistance(DependencyObject obj)
2. {
3. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
4.     <TextBlock localView:Test.Distance="10"></TextBlock>
5. </localView:Test>return (int)obj.GetValue(DistanceProperty);
6. }
8. public static void SetDistance(DependencyObject obj, int value)
9. {
10. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
11.     <TextBlock localView:Test.Distance="10"></TextBlock>
12. </localView:Test>obj.SetValue(DistanceProperty, value);
13. }
16. public static readonly DependencyProperty DistanceProperty =
17. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
18.     <TextBlock localView:Test.Distance="10"></TextBlock>
19. </localView:Test>DependencyProperty.RegisterAttached("Distance", typeof(int), typeof(Test), new PropertyMetadata(0));

复制代码

通过对比，附加属性和依赖属性，存在以下差异：
首先不同就是注册附加属性使用的是名为RegisterAttached 的方法，但参数却与使用 Register方法无异。
附加属性的包装器也与依赖属性不同——依赖属性使用CLR属性对GetValue和 SetValue两个方法进行包装，附加属性则使用两个方法分别进行包装。
创建附加属性后，即可在其子元素上，进行应用，使用方法和Grid.Column，Grid.Row等方式一致。如下所示：

1. <localView:Test x:Name="test" Margin="10" Age="{Binding ElementName=t1, Path=Value}">
2.     <TextBlock localView:Test.Distance="10"></TextBlock>
3. </localView:Test>

复制代码

 
参考文档

 
在本示例中，主要参考官方文档：
官方文档：https://learn.microsoft.com/zh-cn/dotnet/desktop/wpf/advanced/properties-wpf?view=netframeworkdesktop-4.8
 
以上就是【浅谈WPF之属性系统】的全部内容，旨在抛砖引玉，一起学习，共同进步。

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