用户控件自定义 DependencyProperty 属性使用教程

用户控件自定义 DependencyProperty 属性使用教程

• DependencyProperty 概念
• 依赖属性创建
• 自定义控件的依赖属性

DependencyProperty 概念

依赖属性就是一种可以自己没有值，并能通过使用Binding从数据源获得值（依赖在别人身上）的属性。拥有依赖属性的对象称为"依赖对象"。 继承树上可以看出，WPF的所有UI控件都是依赖对象。

WPF开发中，必须使用依赖对象作为依赖属性的宿主，使二者结合起来。依赖对象的概念被DependencyObject类所实现，依赖属性的概念则由DependencyProperty类所实现

WPF框架的编程经常和界面打交道，经常遇到的一个情况是某个属性的值的变化会影响到多个其他对象。比如当一个Button的改变大小超过了它的容器，他的容器应该自动调整大小。于是我们考虑在每个属性的set方法中触发一些事件，但很快我们发现现有的功能很难满足我们的需求，至少不能简洁漂亮的满足这些需求。
实际上我们的需求更加复杂，WPF中的数据绑定，XAML语法等很多地方都和属性密切相关，我们迫切需要一种功能更加强大的属性。

于是在WPF中，引入了一种特殊的属性，Dependency Property。这种属性和普通的属性最大不同在于,它的值的来源并不单一。对这种属性的取值和赋值都会能与其他对象有影响，因此能得到很大的灵活性

依赖属性图片

依赖属性创建

1、输入快捷键 "Propdp" 点击 TAB 按键自动生成默认 依赖属性如下为系统默认依赖属性

public int MyProperty
{
   get { return (int)GetValue(MyPropertyProperty); }
    set { SetValue(MyPropertyProperty, value); }
}

// Using a DependencyProperty as the backing store for MyProperty.  This enables animation, styling, binding, etc...
public static readonly DependencyProperty MyPropertyProperty =
      DependencyProperty.Register("MyProperty", typeof(int), typeof(ownerclass), new PropertyMetadata(0));

按照自己的需要修改依赖属性名称、属性名称。
依赖属性实例并非使用new操作符得到而是使用DependencyProperty.Register方法生成。

DependencyProperty.Register的参数说明

• 第一个参数为int类型，表示指明以哪个CLR属性作为这个依赖属性的包装器。就是代码"MyProperty"
• 第二个参数指明此依赖属性用来存储什么样的值。
• 第三个参数用来指明此依赖属性的宿主是什么类型，或者说DependencyProperty.Register方法要将这个依赖属性注册到哪个类型上

注意

• 1.依赖属性包装器是一个CLR属性，并不是依赖属性，没有包装器，依赖属性依旧存在。

• 2.既然没有包装器依赖属性也存在，那么包装器是干什么用的呢?包装器的作用是以"实例属性"的形式向外界暴露依赖属性，这样，一个依赖属性才能成为数据源的一个Path。

• 3.注册依赖属性时使用的第二个参数是一个数据类型，这个数据类型也是包装器的数据类型。

DependencyProperty.Register带4个参数，第四个参数的类型是PropertyMetadata类，作用是给依赖属性的DefaultMetadata属性赋值。顾名思义，DefaultMetadata的作用就是向依赖属性的调用者提供一些基本信息，这些信息包括：

• CoerceValueCallback：依赖属性的值被强制改变时此委托会被调用，此委托可关联一个函数。
• DefaultValue：依赖属性未被显示赋值时，若读取之则获得此默认值，不设置此值会抛出异常。
• IsSealed：控制PropertyMetadata的属性值是否可以更改，默认值为true。
• PropertyChangeCallback：依赖属性的值被改变之后此委托会被调用，此委托可关联一个函数。

探究

第四个参数支持 PropertyMetadate 类型，同时它派生的UIPropertyMetadata类型
以及UIPropertyMetadata派生的FrameworkPropertyMetadata 在不同类型上实现的效果略有差异，此次提出一个典型

若依赖属性为ObservableCollection<T>的时候，必须要使用FrameworkPropertyMetadata作为参数，代码如下,给DefaultVaule、DefaultUpdateSourceTrigger 赋默认值。

        new FrameworkPropertyMetadata
                {
                    DefaultValue = new ObservableCollection(),
                    DefaultUpdateSourceTrigger = UpdateSourceTrigger.PropertyChanged
                });

到此刻，依赖属性创建已经完成。

自定义控件的依赖属性

依赖属性一般的使用场景为应用在自定义控件上，自定义控件实现依赖属性有如下三个注意点

• 定义对象是int、string等类型的时候，可以使用PropertyMetadate作为触发参数
• 若定义的依赖属性为ObservableCollection 则register 中的第四个参数应该调整为 FrameworkPropertyMetadata，并附上默认值。
• XAML绑定 依赖属性，必须通过 RealtiveSource 实现绑定，不同能通DataContext Self 的形式，因为UserContrl 需要对后续数据源的输入，若使用DataContext Self 的形式，则无法实现数据更新

博主GitHub地址
https://github.com/yuyue5945

关注公众号留下您的困惑或见解

[图片上传失败...(image-c3f681-1615275141762)]