WPF编程宝典 - 04依赖属性

依赖项属性

  依赖项属性是标准.NET属性的全新实现–具有大量新增价值。在 WPF的核心特性(如动画、数据绑定以及样式)中需要嵌入依赖项属性。WPF 元素提供的大多数属性都是依赖项属性。依赖项属性的用法和普通属性是相同的。

定义依赖项属性

  第一步是定义表示属性的对象，它是DependencyProperty类的实例。属性信息应该始终保持可用，甚至可能需要在多个类之间共享这些信息。因此，必须将DependencyProperty对象定义为与其相关联的类的静态字段。

1
2
3
4

public class FrameworkElement : UIElement
{
    public static readonly DependencyProperty MarginProperty;
}

注册依赖项属性

1
2
3
4
5
6
7
8
9
10
11
12
13

static FrameworkElement()
{
    FrameworkPropertyMetadata metadata = new FrameworkPropertyMetadata(
        defaultValue: new Thickness(),
        flags: FrameworkPropertyMetadataOptions.AffectsMeasure);

    MarginProperty = DependencyProperty.Register(
        name: "Margin",
        propertyType: typeof(Thickness),
        ownerType: typeof(FrameworkElement),
        typeMetadata: metadata,
        validateValueCallback: new ValidateValueCallback(FrameworkElement.IsMarginValid));
}

  注册依赖项属性需要经历两个步骤。首先创建FrameworkPropertyMetadata对象，该对象指示希望通过依赖项属性使用什么服务（如支持数据绑定/动画以及日志）。接下来通过调用DependencyProperty.Register()静态方法注册属性。在这一步骤中，需要提供以下几个要素：

• name: 属性名
• propertyType: 属性使用的数据类型
• ownerType: 拥有该属性的类型
• typeMetadata: 一个具有附加属性设置的FrameworkPropertyMetadata对象，该要素是可选的
• validateValueCallback: 一个用于验证属性的回调函数，该要素是可选的

添加属性包装器

  创建依赖项属性的最后一个步骤是使用传统的.NET属性封装 WPF 依赖项属性。但典型的属性过程是检索或设置某个私有字段的值,而 WPF 属性的属性过程是使用在 DependencyObiec基类中定义的 GetValue()和 SetValue()方法，删除值使用ClearValue()方法

1
2
3
4
5

public Thickness Margin
{
    set {SetValue(MarginProperty,value);}
    get {return (Thickness)GetValue(MarginProperty);}
}

WPF使用依赖项属性的方式

  从依赖项属性检索值时，WPF需要考虑多个方面。依赖项属性因该行为得名–本质上，依赖项属性依赖于多个属性提供者,每个提供者都有各自的优先级。当从属性检索值时，WPF属性系统会通过一系列步骤获取最终值。首先通过考虑以下因素(按优先级从低到高的顺序排列)来决定基本值(base value):

1. 默认值（由FeameworkPropertyMetadata对象设置的值）
2. 继承而来（假设设置FrameworkPropertyMetadata.Inherits标志，并为包含层次中的某个元素提供了值）
3. 来自主题样式的值
4. 来自项目样式的值
5. 本地值（使用代码或XAML直接为对象设置的值）

共享的依赖项属性

  尽管一些具有不同的继承层次，但它们会共享同一依赖属性，例如TextBlock.FontFamily属性和Control.FontFamily属性指向同一个静态的依赖项属性，该属性实际上是在 TextElemen类中定义的 TextElement.FontFamilyProperty 依赖项属性。TextElement 类的静态构造函数注册该属性,而TextBlock类和 Control类的静态构造函数只是通过调用DependencyProperty.AddOwner()方法重用该属性:

1
2

TextBlock.FontFamilyProperty = 
    TextElement.FontFamilyProperty.AddOwner(typeof(TextBlock));

附加的依赖项属性

  附加属性时一种依赖项属性，由WPF属性系统管理。不同之处在于附加属性被引用到的类并非定义附加属性的那个类。例如，Grid类定义了Row和Column附加属性，这两个属性被用于设置Gird面板包含的元素，以指明这些元素应被放到哪个单元格中

1
2
3
4
5

FrameworkPropertyMetadata metadata = new FrameworkPropertyMetadata(
    0, new PropertyChangedCallback(Grid.OnCellAttachedPropertyChanged));

Grid.RowProperty = DependencyProperty.RegisterAttached("Row", typeof(int),
    typeof(Grid),metadata,new ValidateValueCall(Grid.IsIntValueNotNegative));

  当创建附加属性时，不必定义.NET 属性封装器。这是因为附加属性可以被用于任何依赖对象。例如，Grid.Row 属性可能被用于 Grid 对象(如果在 Grid 控件中嵌套了另一个 Grid 控件),也可能被用于其他元素。实际上，Grid.Row属性甚至可以被用于并不位于 Grid 控件中的元素甚至在元素树中根本就不存在 Grid 对象。

  不是使用.NET属性封装器，反而附加属性需要调用两个静态方法来设置和获取属性值，这两个方法使用为人熟知的 SetValue()和 GetValue()方法(继承自 DependencyObiect 类)。这两个静态方法应当命名为SetPropertyName()和GetPropertyName()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

public static int GetRow(UIElement element)
{
    if(element == null)
    {
        throw new ArgumentNullException(...);
    }
    return (int)element.GetValue(Grid.RowProperty);
}

public static void SetRow(UIElement element, int value)
{
    if(element == null)
    {
        throw new ArgumentNullException(...);
    }
    element.SetValue(Grid.RowProperty,value);
}

属性验证

  在定义任何类型的属性时，都需要面对错误设置属性的可能性。对于传统的.NET属性，可尝试在属性设置器中捕获这类问题。但对于依赖项属性而言，这种方法不合适，因为可能通过WPF属性系统使用SetValue()方法直接设置属性。

  作为代替，WPF 提供了两种方法来阻止非法值:

• ValidateVaalueCallback: 该回调函数可接受或拒绝新值。通常，该回调函数用于驳货违反了属性约束的明显错误。可作为DependencyProperty.Register()方法的一个参数提供该回调函数
• CoerceValueCallback: 该回调函数可将新值修改为更能被接受的值。该回调函数通常用于处理为相同对象设置的依赖项属性值相互冲突的问题。这些值本身可能时合法的，但当同时应用时它们时不相容的。为了使用这个回调函数，但创建FrameworkPropetyMetadata对象时（然后对该对象将被传递到DependencyProperty.Register()方法），作为构造函数的一个参数提供回调函数

  下面是当应用程序试图设置依赖项属性时，所有这些内容的作用过程:

1. 首先，CoerceValueCallback方法有机会修改提供的值(通常，使提供的值和其他属性相容)，或者返回 DependencyProperty.UnsetValue，这会完全拒绝修改。
2. 接下来激活 ValidateValueCallback方法。该方法返回 true 以接受一个值作为合法值，或者返回 false 拒绝值。与 CoerceValueCallback 方法不同，ValidateValueCallback 方法不能访问设置属性的实际对象，这意味着您不能检查其他属性值。
3. 最后，如果前两个阶段都获得成功，就会触发 PropertyChangedCallback 方法。此时如果希望为其他类提供通知，可以引发更改事件。

验证回调

1
2
3
4
5
6

MarginProperty = DependencyProperty.Register(
        name: "Margin",
        propertyType: typeof(Thickness),
        ownerType: typeof(FrameworkElement),
        typeMetadata: metadata,
        validateValueCallback: new ValidateValueCallback(FrameworkElement.IsMarginValid));

  可使用这个回调函数加强验证，验证通常应被添加到属性过程的设置部分。提供的回调函数必须指向一个接受对象参数并返回 Boolean 值的方法。返回 true 以接受对象是合法的，返回false 拒绝对象。

强制回调

  通过 FrameworkPropertyMetadata对象使用 CoerceValueCallback 回调函数。下面是示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

static RangeBase()
{
    FrameworkPropertyMetadata metadata = new FrameworkPropertyMetadata();
    metadata.CoerceValueCallback = new CoerceValueCallback(CoerceMaximum);

    DependencyProperty.Register("Maximum",typeof(double),
        typeof(RangeBase),metadata);
}

private static object CoerceMaximum(DependencyObject d, object value)
{
    RangeBase base1 (RangeBase)d;
    if((double)value < base1.Minimum) // 最大值不能小于最小值
    {
        return base1.Minimum; // 强制回调可以自定义一个更合理的值返回
    }
    return value;
}