WPF自定義路由事件的實例教程

Posted on by

路由事件模型

傳統的簡單事件模型中，在消息激發是將消息通過事件訂閱的然後交給事件的相應者，事件的相應者使用事件的處理器來做出相應，這樣就存在一個問題，用戶控件內部的事件就不能被外界訂閱，因為事件的宿主必須能夠直接訪問到事件的響應者。

路由事件的事件擁有者和事件的相應者之間則沒有直接的顯式訂閱關系，事件的擁有者則隻負責激發事件，事件將有誰相應它並不知道，事件的響應者則有事件的監聽器，針對事件進行監聽，當有此類事件傳遞至此事件響應者就使用事件處理器來相應事件並決定此事件是否繼續傳遞。比如像上一個程序中的，點擊“點我”以後事件就開始激發瞭，然後事件就會在控件樹上進行傳遞，事件的響應者安裝瞭監聽器，當監聽到這個事件進行響應，並決定這個事件是否繼續傳遞。

瞭解瞭路由事件後，這節來學習一下如何自定義路由事件。

【分析代碼】

在演示代碼前，我們不妨先看一段Button按鈕的Click路由事件源碼，從源碼中學習一下如何定義路由事件。

在ButtonBase中，跟Click路由事件相關的有如下四處代碼：

代碼一

代碼二

代碼三

代碼四

第一段是聲明瞭ClickEvent這一路由事件對象，這個不用多說；

第二段是聲明瞭ClickEvent路由事件對象的包裝器，它類似於屬性的get,set,方便我們從外部把路由事件的處理器附加到路由事件上。當外部進行“+=”操作時，內部就會執行add塊，將事件處理附加到Click路由事件上，反之執行“-=”操作時，會執行remove塊中的內容；

第三段是構造方法中構建Click路由事件對象，跟創建依賴對象類似的是，路由事件對象的創建也不是直接new,而是通過EventManager類的RegisterRoutedEvent方法進行註冊，該方法第一個參數是路由事件的名稱，微軟約定路由事件名稱要跟路由事件對象的包裝器名稱一致，並且跟路由事件對象去掉Event後綴的字樣也要一致。第二個參數是指路由事件的策略，也就是事件傳播的形式，有如下三種枚舉：

  • RoutingStrategy.Tunnel：隧道式，是指事件從最外層的控件開始路由，直到路由到控件自己，就像一條自上往下的隧道，從window控件一路通到當前觸發事件的控件；
  • RoutingStrategy.Bubble：冒泡式，這個跟隧道式相反，它是從觸發事件的控件向上傳播，直到最上層停止；
  • RoutingStrategy.Direct：直通式，跟原始事件模型一樣，不路由，直達事件處理器。

第三個參數是指定該路由事件的事件處理器是什麼類型，第四個參數是指定該路由事件對象的宿主類型，第四個參數跟第一個參數共同用於路由事件對象的內部創建使用：構建hash code,確定路由事件對象唯一性，同依賴屬性一致，在一個類中不能註冊兩個同名的路由事件對象。

第四段是激發Click路由事件的方法，事件參數就是在此方法中處理，它是路由事件傳播之源。

【自定義路由事件】

下面我們就來根據以上語法，基於ButtonBase創建自己的Click路由事件：

public class MyRoutedEventArgs : RoutedEventArgs
    {
        public MyRoutedEventArgs(RoutedEvent routedEvent, object source)
            : base(routedEvent, source) { }

        public string RoutedMessage { get; set; }
    }

    public class MyButton : ButtonBase
    {

        public static readonly RoutedEvent MessageEvent =
           EventManager.RegisterRoutedEvent("Message", RoutingStrategy.Bubble,
               typeof(EventHandler<MyRoutedEventArgs>), typeof(MyButton));

        public event RoutedEventHandler Message
        {
            add { this.AddHandler(MessageEvent, value); }
            remove { this.RemoveHandler(MessageEvent, value); }
        }

        protected override void OnClick()
        {
            base.OnClick();

            MyRoutedEventArgs eventArgs =  new MyRoutedEventArgs(MessageEvent, this) 
                                                { RoutedMessage = "自定義路由事件被觸發瞭" };
            this.RaiseEvent(eventArgs);

        } 
    }

上述代碼中，我創建瞭一個MyButton,聲明瞭一個MessageEvent路由事件對象，值得註意的是，RegisterRoutedEvent的第三個參數我用的是：

typeof(EventHandler<MyRoutedEventArgs>)

而非：

typeof(RoutedEventHandler)

因為RoutedEventHandler的參數跟我自定義的事件參數不一致，需要使用EventHandler的泛型版指定我的事件參數類型，下面是RoutedEventHandler的聲明：

該參數類型是RoutedEventArgs,而我使用的是自定義的MyRoutedEventArgs類型。

XAML部分及事件處理器的代碼為：

在外層Grid上設置MyButton的Message事件監聽及處理器。

運行效果如下：

點擊“你好”，彈出MessageBox提示“自定義路由事件被觸發瞭”。

總結

到此這篇關於WPF自定義路由事件的文章就介紹到這瞭,更多相關WPF自定義路由事件內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：