在這里我們將將打造一個UserControl(用戶控件)來逐步講解如何在WPF中自定義控件,并將WPF的一些新特性引入到自定義控件中來.
我們制作了一個帶語音報時功能的鐘表控件, 效果如下:


在VS中右鍵單擊你的項目,點擊"添加新項目",在出現的選擇列表中選擇"UserControl",VS會自動為你生成一個*.xaml文件以及其對應的后臺代碼文件(*.cs或其它).
值得注意的是,自動生成的代碼中,你的控件是繼承于System.Windows.Controls.UserControl類的,這對應你的控件而言并不一定是最恰當的基類,你可以修改它,但注意你應該同時修改*.cs文件和*.xaml文件中的基類,而不只是修改*.cs文件,否則當生成項目時會報錯"不是繼承于同一基類".修改*.xaml文件的方法是:將該文件的第一行和最后一行的"UserControl"改成與你認為恰當的基類名稱.

1,為控件添加屬性(依賴屬性,DependencyProperty)
正如下面的代碼所示:

public?static?readonly?DependencyProperty?TimeProperty?=?
????????????DependencyProperty.Register("Time",?typeof(DateTime),?typeof(ClockUserCtrl),?
????????????new?FrameworkPropertyMetadata(DateTime.Now,new?PropertyChangedCallback(TimePropertyChangedCallback)));

我們為控件(或者任何一個WPF類)添加的依賴屬性都是"公開的","靜態的","只讀的",其命名方式是"屬性名+Property",這是依賴屬性一成不變的書寫方式.對于依賴屬性的注冊可以在聲明該屬性時就調用DependencyProperty.Register()方法注冊,也可以在其靜態構造方法中注冊.上面的DependencyProperty.Register方法的幾個參數分別是:屬性名(該屬性名與聲明的依賴屬性名稱"XXXProperty"相比僅僅是少了"Property"后綴,其它完全一樣,否則在運行時會報異常),屬性的數據類型,屬性的擁有者的類型,元數據.
關于參數中傳遞的元數據:如果是普通的類則應該傳遞PropertyMetadata,如果是FrameworkElement則可以傳遞FrameworkPropertyMetadata,其中FrameworkPropertyMetadata中可以制定一些標記表明該屬性發生變化時控件應該做出什么反應,比如某屬性的變化會影響到該控件的繪制,那么就應該像這樣書寫該屬性的元數據:?new FrameworkPropertyMetadata(defauleValue, FrameworkPropertyMetadataOptions.AffectsRender);這樣當該屬性發生變化時系統會考慮重繪該控件.另外元數據中還保護很多內容,比如默認值,數據驗證,數據變化時的回調函數,是否參與屬性"繼承"等.
然后,我們將該依賴屬性包裝成普通屬性:

????????[Description("獲取或設置當前日期和時間")]
????????[Category("Common?Properties")]
????????public?DateTime?Time
????????{
????????????get
????????????{
????????????????return?(DateTime)this.GetValue(TimeProperty);
????????????}
????????????set
????????????{
????????????????this.SetValue(TimeProperty,?value);
????????????}
????????}

GetValue和SetValue方法來自于DependencyObject類,其用于獲取或設置類的某屬性值.
注意:在將依賴屬性包裝成普通屬性時,在get和set塊中除了按部就班的調用GetValue和SetValue方法外,不要進行任何其它的操作.下面的代碼是不恰當的:

????????[Description("獲取或設置當前日期和時間")]
????????[Category("Common?Properties")]
????????public?DateTime?Time
????????{
????????????get
????????????{
????????????????return?(DateTime)this.GetValue(TimeProperty);
????????????}
????????????set
????????????{
????????????????this.SetValue(TimeProperty,?value);
????????????????this.OnTimeUpdated(value);//Error
????????????}
????????}

在以前這或許是很多人的慣用寫法,但在WPF中,這樣的寫法存在潛在的錯誤,原因如下:我們知道繼承于DependencyObject的類擁有GetValue和SetValue方法來獲取或設置屬性值,那為什么我們不直接使用該方法來獲取或設置屬性值,而要將其包裝成普通的.NET屬性呢,事實上在這里兩種方式都是可以的,只不過包裝成普通的.NET屬性更符合.NET開發人員的習慣,使用GetValue和SetValue更像JAVA開發人員的習慣,但XAML在執行時似乎于JAVA開發人員一樣,其不會調用.NET屬性而是直接使用GetValue或SetValue方法,這樣一來,我們寫在get塊和set塊中的其它代碼根本不會被XAML執行到.所以說,就上面的Time屬性而言,C#(或其它)對該屬性的調用不會出現任何問題,但該屬性被用在XAML中時(比如在XAML對該屬性進行數據綁定等),其set塊中的this.OnTimeUpdated(value);語句不會被執行到.
那么,當Time屬性發生變化時的確需要調用this.OnTimeUpdated(value);語句(因為該語句會引發時間被更新了的事件),還是在傳遞的依賴屬性元數據做文章:
new FrameworkPropertyMetadata(DateTime.Now,new?PropertyChangedCallback(TimePropertyChangedCallback)),我們為屬性的變化指定了一個回調函數,當該屬性變化時該回調函數就會被執行:

????????private?static?void?TimePropertyChangedCallback(DependencyObject?sender,?DependencyPropertyChangedEventArgs?arg)
????????{
????????????if?(sender?!=?null?&&?sender?is?ClockUserCtrl)
????????????{
????????????????ClockUserCtrl?clock?=?sender?as?ClockUserCtrl;
????????????????clock.OnTimeUpdated((DateTime)arg.OldValue,?(DateTime)arg.NewValue);
????????????????
????????????}
????????}

2,為控件添加事件(傳閱事件,RoutedEvent)
添加傳閱事件的方法與添加依賴屬性的方法很類似:

????????public?static?readonly?RoutedEvent?TimeUpdatedEvent?=?
????????????EventManager.RegisterRoutedEvent("TimeUpdated",
?????????????RoutingStrategy.Bubble,?typeof(RoutedPropertyChangedEventHandler<DateTime>),?typeof(ClockUserCtrl));

其支持方法EventManager.RegisterRoutedEvent()對應的幾個參數分別為:事件名稱,事件傳閱的方式(向上傳閱,向下傳閱或不傳閱),事件對應的EventHandler的類型,事件擁有者的類型)
然后將事件包裝成普通的.NET事件:

????????[Description("日期或時間被更新后發生")]
????????public?event?RoutedPropertyChangedEventHandler<DateTime>?TimeUpdated
????????{
????????????add
????????????{
????????????????this.AddHandler(TimeUpdatedEvent,?value);
????????????}
????????????remove
????????????{
????????????????this.RemoveHandler(TimeUpdatedEvent,?value);
????????????}
????????}

注意,與依賴屬性一樣,不要在add與remove塊中添加除AddHandler與RemoveHandler以外的代碼.
題外話,事件參數中的e.Handled=true并不是終止事件的傳閱,這只是為事件做一個標記而已,以便在默認情況下的讓那些事件處理函數在該標記為true的情況下不被調用,要為該標記為true的事件注冊處理方法并讓該方法得到執行,請使用AddHandler方法,并把最后一個參數handlerEventsToo設置為true,如下:

this.myInkCanvas.AddHandler(
??????InkCanvas.MouseLeftButtonDownEvent,
??????new?MouseButtonEventHandler(
??????????myInkCanvas_MouseLeftButtonDown),
??????true);

private?void?myInkCanvas_MouseLeftButtonDown(
???????object?sender,?MouseButtonEventArgs?e)
{
???????//do?something
}

然后編寫慣用的OnXXX方法:

????????protected?virtual?void?OnTimeUpdated(DateTime?oldValue,?DateTime?newValue)
????????{
????????????RoutedPropertyChangedEventArgs<DateTime>?arg?=?
????????????????new?RoutedPropertyChangedEventArgs<DateTime>(oldValue,?newValue,TimeUpdatedEvent);
????????????this.RaiseEvent(arg);
????????????
????????}

3,為控件添加命令(Commands)
能為自定義控件添加如WPF內置控件一樣的命令是一件很不錯的事情(事實上這也是在CustomControl中降低界面和后臺邏輯耦合度的一種方法,本系列隨筆中的下一篇中將會具體談談).
WPF中內置的命令有兩大類型:RoutedCommand以及RoutedUICommand,后者比前者多了一個Text屬性用于在界面上自動本地化地顯示該命令對應的文本,更多的可以參考WPF中的命令與命令綁定(一)以及WPF中的命令與命令綁定(二).?
這里我們來定義一個命令,其功能是控件的語音報時.首先我們定義一個命令:

????????public?static?readonly?RoutedUICommand?SpeakCommand?=?new?RoutedUICommand("Speak",?"Speak",?typeof(ClockUserCtrl));

參數分別為命名的顯示名稱,命令的名稱,命令的擁有者類型.
然后在控件的靜態函數中定義一個命令綁定,該命令綁定定義了命令的具體細節:對應的命令是什么?其完成什么樣的功能,當前環境下其能執行嗎?

????????????CommandBinding?commandBinding?=
????????????????new?CommandBinding(SpeakCommand,?new?ExecutedRoutedEventHandler(ExecuteSpeak),
????????????????new?CanExecuteRoutedEventHandler(CanExecuteSpeak)); ????????private?static?void?ExecuteSpeak(object?sender,?ExecutedRoutedEventArgs?arg)
????????{
????????????ClockUserCtrl?clock?=?sender?as?ClockUserCtrl;
????????????if?(clock?!=?null)
????????????{
????????????????clock.SpeakTheTime();
????????????}
????????}

????????private?static?void?CanExecuteSpeak(object?sender,?CanExecuteRoutedEventArgs?arg)
????????{
????????????ClockUserCtrl?clock?=?sender?as?ClockUserCtrl;
????????????arg.CanExecute?=?(clock?!=?null);
????????}

CanExecuteRoutedEventArgs的CanExecute屬性用于指示當前命令是否可用,也就是說系統會不斷地檢視該命令與該命令的作用對象,并根據你所提供的條件來判斷當前命令是否可用,比如文本框狀態變為"只讀"后,其"粘貼"命令將不可用,作用于該文本框的粘貼按鈕會自動被禁用,反之則啟用.
new ExecutedRoutedEventHandler(ExecuteSpeak)委托指定了當該命令被執行時所要完成的任務,這通過回調ExcuteSpeak函數來實現.

????????private?static?void?ExecuteSpeak(object?sender,?ExecutedRoutedEventArgs?arg)
????????{
????????????ClockUserCtrl?clock?=?sender?as?ClockUserCtrl;
????????????if?(clock?!=?null)
????????????{
????????????????clock.SpeakTheTime();
????????????}
????????} ????????private?void?SpeakTheTime()
????????{
????????????DateTime?localTime?=?this.Time.ToLocalTime();
????????????string?textToSpeak?=?"現在時刻,"?+?
????????????????localTime.ToShortDateString()?+","+
????????????????localTime.ToShortTimeString()??+?
????????????????",星期"?+?(int)localTime.DayOfWeek;

????????????this.speecher.SpeakAsync(textToSpeak);
????????}

我們也可以為命令添加快捷鍵,這是通過InputBinding來實現的,其將命令與命令的快捷鍵關聯起來,比如:

????????????InputBinding?inputBinding?=?new?InputBinding(SpeakCommand,?new?MouseGesture(MouseAction.LeftClick));
????????????CommandManager.RegisterClassInputBinding(typeof(ClockUserCtrl),?inputBinding);

這樣,當我們鼠標點擊控件時就會引發控件的Speak命令,從而調用SpeakTheTime函數進行語音播報.
快捷鍵可以通過MouseGesture或KeyGesture來定義.

4,優點與缺點:
正如在在WPF中自定義控件(1)?中談到的一樣,UserControl能比較快速的打造自定義控件,但其對模板樣式等缺乏很好的支持,打造出來的控件不如WPF內置控件一樣靈活,在本系列隨筆的下一篇中,我們將介紹如何打造能對WPF新特性提供完全支持的CustomControl.

DEMO

?

轉自:?http://www.cnblogs.com/zhouyinhui/archive/2007/10/27/939920.html 作者：周銀輝

轉載于:https://www.cnblogs.com/luohengstudy/p/9888075.html

與50位技術專家面對面20年技術見證，附贈技術全景圖

總結

以上是生活随笔為你收集整理的[转]在WPF中自定义控件 UserControl的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。