WPF依賴屬性用法詳解

2022-02-25 13:00:22

一、什麼是依賴屬性

依賴屬性就是一種自己可以沒有值，並且可以通過繫結從其他資料來源獲取值。依賴屬性可支援WPF中的樣式設定、資料繫結、繼承、動畫及預設值。

將所有的屬性都設定為依賴屬性並不總是正確的解決方案，具體取決於其應用場景。有時，使用私有欄位實現屬性的典型方法便能滿足要求。MSDN中給出了下面幾種應用依賴屬性的場景：

1. 希望可在樣式中設定屬性。
2. 希望屬性支援資料繫結。
3. 希望可使用動態資源參照設定屬性。
4. 希望從元素樹中的父元素自動繼承屬性值。
5. 希望屬性可進行動畫處理。
6. 希望屬性系統在屬性系統、環境或使用者執行的操作或者讀取並使用樣式更改了屬性以前的值時報告。
7. 希望使用已建立的、WPF 程序也使用的後設資料約定，例如報告更改屬性值時是否要求佈局系統重新編寫元素的視覺化物件。

二、依賴屬性的特點

1、屬性變更通知

無論什麼時候，只要依賴屬性的值發生改變，wpf就會自動根據屬性的後設資料觸發一系列的動作，這些動作可以重新呈現UI元素，也可以更新當前的佈局，重新整理資料繫結等等，這種變更的通知最有趣的特點之一就是屬性觸發器，它可以在屬性值改變的時候，執行一系列自定義的動作，而不需要更改任何其他的程式碼來實現。通過下面的範例來演示屬性變更通知

範例：當滑鼠移動到Button按鈕上面時，文字的前景色變為紅色，離開時變為預設顏色黑色，採用傳統方式和依賴屬性兩種方式實現：

（1）、使用傳統方式實現，在Button按鈕上定義MouseEnter和MouseLeave兩個事件，分別處理滑鼠移動到按鈕上面和離開，XAML介面程式碼：

<Window x:Class="WpfDemo.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="Grid面板" Height="237" Width="525" WindowStartupLocation="CenterScreen">
    <Grid >              
        <Button Height="30" Width="200" MouseEnter="Button_MouseEnter" MouseLeave="Button_MouseLeave" >滑鼠移動到上面，前景色變為紅色</Button>        
    </Grid>
</Window>

C#後臺程式碼實現：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Navigation;
using System.Windows.Shapes;

namespace WpfDemo
{
    /// <summary>
    /// MainWindow.xaml 的互動邏輯
    /// </summary>
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        /// <summary>
        /// 滑鼠移動到按鈕上面
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void Button_MouseEnter(object sender, MouseEventArgs e)
        {
            Button btn = sender as Button;
            if (btn != null)
            {
                btn.Foreground = Brushes.Red;
            }
        }

        /// <summary>
        /// 滑鼠離開按鈕
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void Button_MouseLeave(object sender, MouseEventArgs e)
        {
            Button btn = sender as Button;
            if (btn != null)
            {
                btn.Foreground = Brushes.Black;
            }
        }
    }
}

（2）使用依賴屬性實現，XAML介面程式碼：

<Window x:Class="WpfDemo.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="Grid面板" Height="237" Width="525" WindowStartupLocation="CenterScreen">
    <Grid >
        <Button Height="30" Width="200">滑鼠移動到上面，前景色變為紅色
            <Button.Style>
                <Style TargetType="Button">
                    <Style.Triggers>
                        <Trigger Property="IsMouseOver" Value="true">
                            <Setter Property="Foreground" Value="Red"></Setter>
                        </Trigger>
                    </Style.Triggers>
                </Style>
            </Button.Style>
        </Button>
    </Grid>
</Window>

使用上面的兩種方式都可以實現Button按鈕的前景色改變，效果如下：

在判斷屬性IsMouseOver的值為false的時候，自動將Foreground的值改為之前的值，因此就不需要寫IsMouseOver的值為false的時候，將Foreground的值改為Black。

2、屬性值繼承

是指屬性值自頂向下沿著元素樹進行傳遞。

<Window x:Class="WpfDemo.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="依賴屬性" Height="237" Width="525" FontSize="18" WindowStartupLocation="CenterScreen">
    <Grid >
        <StackPanel>
            <TextBlock>我使用的是繼承的fontsize</TextBlock>
            <TextBlock FontSize="11">我使用的是自己的fontsize</TextBlock>
        </StackPanel>
    </Grid>
</Window>

介面執行效果：

3、節省記憶體空間

依賴屬性和CLR屬性在記憶體的使用上是截然不同的，每個CLR屬性都包含一個非static的欄位，因此當我們範例化一個型別的時候，就會建立該型別所擁有的所有CLR屬性，也就是說一個物件所佔用的記憶體在呼叫new操作進行範例化的時候就已經決定了、而wpf允許物件在建立的時候並不包含用於儲存資料的空間，只保留在需要用到資料的時候能夠獲得該預設值，即用其他物件資料或者實時分配空間的能力。

三、如何自定義依賴屬性

1、宣告依賴屬性變數。依賴屬性的宣告都是通過public static來公開一個靜態變數，變數的型別必須是DependencyProperty
2、在屬性系統中進行註冊。使用DependencyProperty.Register方法來註冊依賴屬性，或者是使用DependencyProperty.RegisterReadOnly方法來註冊
3、使用.NET屬性包裝依賴屬性

在類上實現屬性時，只要該類派生自 DependencyObject，便可以選擇使用 DependencyProperty 識別符號來標示屬性，從而將其設定為依賴屬性。其語法如下：

public static DependencyProperty TextProperty;
       TextProperty =
       DependencyProperty.Register("Text", //屬性名稱
       typeof(string), //屬性型別
       typeof(TestDependencyPropertyWindow), //該屬性所有者，即將該屬性註冊到那個類上
       new PropertyMetadata("")); //屬性預設值

public string Text
{
   get { return (string)GetValue(TextProperty); }
   set { SetValue(TextProperty, value); }
}

範例：自定義一個依賴屬性，介面包括一個TextBox和TextBlock，TextBlock上面字型的前景色隨TextBox裡面輸入的顏色而改變，如果TextBox裡面輸入的值可以轉換成顏色，TextBlock字型的前景色會顯示輸入的顏色值，如果不能轉換，顯示預設的前景色。

1、在當前專案裡面新增一個WPF版的使用者控制元件，命名為“MyDependencyProperty”，在MyDependencyProperty.xaml.cs檔案裡面自定義一個依賴屬性：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Navigation;
using System.Windows.Shapes;

namespace WpfDemo
{
    /// <summary>
    /// MyDependencyProperty.xaml 的互動邏輯
    /// </summary>
    public partial class MyDependencyProperty : UserControl
    {
        public MyDependencyProperty()
        {
            InitializeComponent();
        }

        //1、宣告依賴屬性變數
        public static readonly DependencyProperty MyColorProperty;

        //2、在屬性系統中進行註冊
        static MyDependencyProperty()
        {
            MyColorProperty = DependencyProperty.Register("MyColor", typeof(string), typeof(MyDependencyProperty),
                new PropertyMetadata("Red", (s, e) =>
                {
                    var mdp = s as MyDependencyProperty;
                    if (mdp != null)
                    {
                        try
                        {
                            var color = (Color)ColorConverter.ConvertFromString(e.NewValue.ToString());
                            mdp.Foreground = new SolidColorBrush(color);
                        }
                        catch
                        {
                            mdp.Foreground = new SolidColorBrush(Colors.Black);
                        }
                    }

                }));
        }

        //3、使用.NET屬性包裝依賴屬性:屬性名稱與註冊時候的名稱必須一致，
        //即屬性名MyColor對應註冊時的MyColor
        public string MyColor
        {
            get
            {
                return (string)GetValue(MyColorProperty);
            }
            set
            {
                SetValue(MyColorProperty, value);
            }
        }
    }
}

快速定義依賴屬性的快捷方式：

輸入propdp，連續按兩下Tab健，自動生成定義依賴屬性的語法。和輸入cw連續按兩下Tab健，自動生成Console.Write()一樣。

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));

2、在MyDependencyProperty.xaml裡面新增一個TextBlock

<UserControl x:Class="WpfDemo.MyDependencyProperty"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
             xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
             mc:Ignorable="d"
             d:DesignHeight="300" d:DesignWidth="300">
    <Grid>
        <TextBlock>我是自定義的依賴屬性</TextBlock>
    </Grid>
</UserControl>

3、在MainWindow.xaml裡面參照新建立的使用者控制元件，並新增一個TextBox，用於輸入顏色值，並將自定義的依賴屬性MyColor繫結到TextBox

<Window x:Class="WpfDemo.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:p="clr-namespace:WpfDemo"
        Title="依賴屬性" Height="237" Width="525" WindowStartupLocation="CenterScreen">
    <Grid >
        <StackPanel>
            <TextBox Name="tbColor"></TextBox>
            <p:MyDependencyProperty MyColor="{Binding Path=Text,ElementName=tbColor}" ></p:MyDependencyProperty>
        </StackPanel>
    </Grid>
</Window>

在設計介面顯示的效果：