【WPF學習】第十三章 理解路由事件
每個.NET開發人員都熟悉“事件”的思想——當有意義的事情發生時,由物件(如WPF元素)傳送的用於通知程式碼的訊息。WPF通過事件路由(event routing)的概念增強了.NET事件模型。事件路由允許源自某個元素的事件由另一個元素引發。例如,使用事件路由,來自工具欄按鈕的單擊事件可在被程式碼處理之前上傳到工具欄,然後上傳到包含工具欄的視窗。
事件路由為在最合適的位置編寫緊湊的、組織良好的用於處理事件的程式碼提供了靈活性。要使用WPF內容模型,事件路由也是必需的,內容模型允許使用許多不同的元素構建簡單元素(如按鈕),並且這些元素都擁有自己獨立的事件集合。
一、定義、註冊和封裝路由事件
WPF事件模型和WPF屬性模型非常類似。與依賴項屬性一樣,路由事件由只讀的靜態欄位表示,在靜態建構函式中註冊,並通過標準的.NET事件定義進行封裝。
例如,WPF的Button類提供了大家熟悉的Click事件,該事件繼承自抽象的ButtonBase基類。下面的程式碼說明了該事件是如何被定義和註冊的:
public abstract class ButtonBase:ContentControl,... { public static readonly RoutedEvent ClickEvent; static ButtonBase() { ButtonBase.ClickEvent=EventManager.RegisterRoutedEvent("Click",RoutingStrategy.Bubble,typeof(RoutedEventHandler),typeof(ButtonBase)); ... } public event RoutedEventHandler Click { add { base.AddHandler(ButtonBase.ClickEvent,value); } remove { base.RemoveHandler(ButtonBase.ClickEvent,value); } } ... }
依賴項屬性是使用DependencyProperty.Register()方法註冊的,而路由事件是使用EvenetManager.RegisterRoutedEvent()方法註冊的。當註冊事件時,需要制定事件的名稱、路由型別、定義事件處理程式語法的委託以及擁有事件的類。
通常,路由事件通過普遍的.NET事件進行封裝,從而使用所有.NET語言都能訪問他們。事件封裝器可使用AddHandler()和RemoveHandler()方法新增和刪除已註冊的呼叫程式,這兩個方法都在FrameworkElement基類中定義,並被每個WPF元素繼承。
二、共享路由事件
與依賴項屬性一樣,可在類之間共享路由事件的定義。例如,UIElement(該類是所有普通WPF元素的起點)和ContentElement(該類是所有內容元素的起點,內容元素是可以被放入流文件中的單獨內容片斷)這兩個基類都使用了MouseUp事件。MouseUp事件是由System.Windows.Input.Mouse類定義的。UIElement類和ContentElement類只通過Routed-Event.AddOwner()方法重用MouseUp事件:
UIElement.MouseUpEvent=Mouse.MouseUpEvent.AddOwner(typeof(UIElement));
三、引發路由事件
當然,與所有事件類似,定義類需要在一些情況下引發事件。到底在哪裡發生是實現細節。然而,重要的細節是事件不是通過傳統的.NET事件封裝器引發的,而是使用RaiseEvent()方法引發事件,所有元素都從UIElement類基礎了該方法。下面是來自ButtonBase類深層的程式碼:
RoutedEventArgs e=new RoutedEventArgs(ButtonBase.ClickEvent,this); base.RaiseEvent(e);
RaiseEvent()方法負責為每個已經通過AddHandler()方法註冊的呼叫程式引發事件。因為AddHandler()方法是公有的,所有呼叫程式可訪問該方法——他們能夠通過直接呼叫AddHandler()方法註冊他們自己,也可以使用事件封裝器。無論使用哪種方法,當呼叫RaiseEvent()方法時都會通知他們。
所有WPF事件都為事件簽名使用熟悉的.NET約定。每個事件處理程式的第一個引數(sender引數)都提供引發該事件的物件的引用。第二個引數是EventArgs物件,該物件與其他所有可能很重要的附加細節繫結在一起。例如,MouseUp事件提供了一個MouseEventArgs物件,用於指示當事件發生時按下了哪些滑鼠鍵:
private void img_MouseUp(object sender,MouseButtonEventArgs e) { }
在WPF中,如果事件不需要傳遞任何額外細節,可使用RoutedEventArgs類,該類包含了有關如何傳遞事件的一些細節。如果事件確實需要傳遞額外的資訊,那麼需要使用更特殊的繼承自RoutedEventArgs的物件(如上面示例中的MouseButtonEventArgs)。因為每個WPF事件引數都繼承自RoutedEventArgs類,所以每個WPF事件處理程式都可訪問與事件路由相關的資訊。
四、處理路由事件
正如前幾章介紹,可以使用多種方法關聯事件處理程式。最常用的方法是為XAML標記新增事件特性。事件特性按照想要處理的事件命名,它的值就是事件處理程式方法的名稱。下面的示例使用這一語法將Image物件的MouseUp事件連線到名為img_MouseUp的事件處理程式:
<Image Source="a.jpg" Stretch="None" Name="img" MouseUp="img_MouseUp" />
通常約定以"元素名_事件名"的形式命名事件處理程式方法,但這不是必需的。如果沒有為元素定義名稱(可能是因為不需要在程式碼的任何地方與元素進行互動),可考慮使用以下形式的事件名稱:
<Button Click="cmdOK_Click">OK</Button>
也可以使用程式碼連線事件。下面的程式碼和上面給出的XAML標記具有相同的效果:
img.MouseUp+=new MouseButtonEventHandler(img_MouseUp);
上面的程式碼建立了一個針對該事件具有正確的簽名的委託物件(在該例中,是MouseButtonEventHandler委託的例項),並將該委託指向img_MouseUp()方法。然後將該委託新增到img.MouseUp事件的已註冊的事件處理程式列表中。
C#還允許使用更精簡的語法,隱式地建立合適的委託物件:
img.MouseUp+=img_MouseUp;
如果需要動態建立控制元件,並在視窗生命週期的某一時刻關聯事件處理程式,程式碼方法是非常有用的。相比而言,在XAML中關聯的事件總在視窗物件第一次例項化時就被關聯到相應的事件處理程式。程式碼方法是XAML更簡單,更精練,如果計劃於非程式設計人員(如藝術設計人員)合作,這是非常好的。缺點是大量的樣板程式碼會使程式碼檔案變得雜亂五章。
上面的程式碼方法依賴與事件封裝器,時間封裝器呼叫UIElement.AddHandler()方法。也可以自行通過呼叫UIElement.AddHandler()方法直接連線事件。下面是一個示例:
img.AddHandler(Image.MouseUpEvent,new MouseButtonEventHandler(img_MouseUp));
當使用這種方法時,始終需要建立合適的委託型別(如MouseButtonEventHandler),而不能隱式地建立委託物件(這與通過屬性封裝器關聯事件時不同)。這是因為UIElement.AddHandler()方法支援所有WPF事件,並且它不知道你想使用的委託型別。
有些開發人員更喜歡使用定義事件的類的名稱,而不是引發事件的類的名稱。例如下面的等效語法使得MouseUp事件在UIElement中定義的這一事實更加清晰:
img.AddHandler(UIElment.MouseUpEvent,new MouseButtonEventHandler(img_MouseUp));
如果想斷開事件處理程式,那麼只能使用程式碼。可使用-=運算子,如下所示:
img.MouseUp -=img_MouseUp;
或者使用UIElement.RemoveHandler()方法:
img.RemoveHandler(UIElment.MouseUpEvent,new MouseButtonEventHandler(img_MouseUp));
為同一事件多次連線相同的事件處理程式,在技術角度上可行的,這通常是編碼錯誤的結果(這種情況下,事件處理程式會觸發多次)。如果試圖刪除已經連線了兩次的事件處理程式,事件仍會觸發事件處理程式,但只觸發一次。