WPF路由事件中的三種策略介紹

更新時(shí)間：2022年02月25日 15:22:29 作者：.NET開(kāi)發(fā)菜鳥

這篇文章介紹了WPF路由事件中的三種策略，文中通過(guò)示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

什么是路由事件

路由事件是具有更強(qiáng)傳播能力的事件，它可以在元素樹中向上冒泡和向下隧道傳播，并且能夠沿著傳播路徑被事件處理程序來(lái)處理。

路由事件允許事件在某個(gè)元素上被處理，即使這個(gè)事件源自于另外一個(gè)元素。事件路由允許某個(gè)元素的事件由另外一個(gè)元素引發(fā)。

路由事件是一種可以針對(duì)元素樹中的多個(gè)偵聽(tīng)器而不是僅僅針對(duì)引發(fā)該事件的對(duì)象調(diào)用處理程序的事件。路由事件是一個(gè)CLR事件。

路由事件與一般事件的區(qū)別在于：路由事件是一種用于元素樹的事件，當(dāng)路由事件觸發(fā)后，它可以向上或向下遍歷可視樹和邏輯樹，他用一種簡(jiǎn)單而持久的方式在每個(gè)元素上觸發(fā)，而不需要任何定制的代碼（如果用傳統(tǒng)的方式實(shí)現(xiàn)一個(gè)操作，執(zhí)行整個(gè)事件的調(diào)用則需要執(zhí)行代碼將事件串聯(lián)起來(lái)）。

路由事件的路由策略：

所謂的路由策略就是指：路由事件實(shí)現(xiàn)遍歷元素的方式。

路由事件一般使用以下三種路由策略：

冒泡路由事件：冒泡路由事件在包含層次中向上傳遞，即由事件源向上傳遞一直到根元素。
直接路由事件：直接路由事件與普通的.NET事件是非常相似的，他們都起源于一個(gè)元素，并且不能夠傳遞給其它的元素。只有事件源才有機(jī)會(huì)響應(yīng)事件。
隧道路由事件：從元素樹的根部調(diào)用事件處理程序并依次向下深入直到事件源。一般情況下，WPF提供的輸入事件都是以隧道/冒泡對(duì)實(shí)現(xiàn)的。隧道事件常常被稱為Preview事件。

1、冒泡路由事件

XAML代碼如下：

<Window x:Class="WpfRouteEventByBubble.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="MainWindow" Height="190" Width="246" WindowStartupLocation="CenterScreen">
    <Grid x:Name="GridRoot" Background="Lime">
        <Grid x:Name="GridA" Margin="10" Background="Blue">
            <Grid.ColumnDefinitions>
                <ColumnDefinition></ColumnDefinition>
                <ColumnDefinition></ColumnDefinition>
            </Grid.ColumnDefinitions>
            <Canvas x:Name="CanvasLeft" Grid.Column="0" Background="Red" Margin="10">
                <Button x:Name="ButtonLeft" Width="65" Height="100" Margin="10" Content="Left"></Button>
            </Canvas>
            <Canvas x:Name="CanvasRight" Grid.Column="1" Background="Yellow" Margin="10">
                <Button x:Name="ButtonRight" Width="65" Height="100" Margin="10" Content="Right"></Button>
            </Canvas>
        </Grid>
    </Grid>
</Window>

運(yùn)行效果如下所示：

當(dāng)單擊Left按鈕的時(shí)候，Button.Click事件被觸發(fā)，并且沿著ButtonLeft→CanvasLeft→GridA→GridRoot→Window這條路線向上傳遞，當(dāng)單擊Right按鈕就會(huì)沿著ButtonRight→CanvasRight→GridA→GridRoot→Window這條路線向上傳遞，這里還沒(méi)有添加監(jiān)聽(tīng)器，所以是沒(méi)有反應(yīng)的。

如何加入監(jiān)聽(tīng)器，我們可以再XAML中添加,XAML代碼如下：

<Window x:Class="WpfRouteEventByBubble.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="MainWindow" Height="190" Width="246" WindowStartupLocation="CenterScreen">
    <Grid x:Name="GridRoot" Background="Lime" Button.Click="Button_Click">
        <Grid x:Name="GridA" Margin="10" Background="Blue" Button.Click="Button_Click">
            <Grid.ColumnDefinitions>
                <ColumnDefinition></ColumnDefinition>
                <ColumnDefinition></ColumnDefinition>
            </Grid.ColumnDefinitions>
            <Canvas x:Name="CanvasLeft" Grid.Column="0" Background="Red" Margin="10" Button.Click="Button_Click">
                <Button x:Name="ButtonLeft" Width="65" Height="100" Margin="10" Content="Left" Button.Click="Button_Click"></Button>
            </Canvas>
            <Canvas x:Name="CanvasRight" Grid.Column="1" Background="Yellow" Margin="10" Button.Click="Button_Click">
                <Button x:Name="ButtonRight" Width="65" Height="100" Margin="10" Content="Right" Button.Click="Button_Click"></Button>
            </Canvas>
        </Grid>
    </Grid>
</Window>

我們?cè)赬AML代碼中添加了Button.Click="Button_Click"這個(gè)事件處理器，就是監(jiān)聽(tīng)器，并且事件處理交由Button_Click負(fù)責(zé)，后臺(tái)Button_Click代碼如下：

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 WpfRouteEventByBubble
{
    /// <summary>
    /// MainWindow.xaml 的交互邏輯
    /// </summary>
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private void Button_Click(object sender, RoutedEventArgs e)
        {
            MessageBox.Show("我到達(dá)了:" + (sender as FrameworkElement).Name);
        }
    }
}

我們分析一下，那兩個(gè)參數(shù)到底是什么呢？

參數(shù)一：sender,這是聽(tīng)者，就是監(jiān)聽(tīng)的地方，如果點(diǎn)擊了Left按鈕，那么Left按鈕就會(huì)大聲說(shuō)：“我被點(diǎn)擊了”這個(gè)事件向上傳遞，知道到了設(shè)有監(jiān)聽(tīng)Button.Click事件的地方，這個(gè)地方就是sender。
參數(shù)二：是RoutEventArgs類型的，這個(gè)參數(shù)攜帶了一些重要信息，例如事件是從哪里來(lái)的，上一個(gè)傳到哪里等，都可以利用這個(gè)參數(shù)來(lái)查詢。

運(yùn)行效果如下：

我們會(huì)發(fā)現(xiàn)，當(dāng)點(diǎn)擊button按鈕時(shí)，ButtonLeft、CanvasLeft、GridA、GridRoot中的事件都會(huì)觸發(fā)，這就是冒泡路由策略的功能所在，事件首先在源元素上觸發(fā)，然后從每一個(gè)元素向上沿著樹傳遞，直到到達(dá)根元素為止（或者直到處理程序把事件標(biāo)記為已處理為止），從而調(diào)用這些元素中的路由事件。

如果把Button_Click事件修改為：

 private void Button_Click(object sender, RoutedEventArgs e)
 {
        MessageBox.Show("我到達(dá)了:" + (sender as FrameworkElement).Name);
        e.Handled = true;//讓事件停止冒泡
}

則以上事件就不會(huì)沿著ButtonLeft→CanvasLeft→GridA→GridRoot→Window這條路線傳遞下去，只會(huì)執(zhí)行ButtonLeft的事件。

MouseUp就是一個(gè)冒泡路由事件，看下面的XAML代碼：

<Window x:Class="路由事件.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:路由事件"
        mc:Ignorable="d"
        Title="冒泡路由事件" Height="596" Width="886"
        MouseUp="SomethingClicked" WindowStartupLocation="CenterScreen">
    <Grid Margin="3" MouseUp="SomethingClicked">
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto"></RowDefinition>
            <RowDefinition Height="*"></RowDefinition>
            <RowDefinition Height="Auto"></RowDefinition>
            <RowDefinition Height="Auto"></RowDefinition>
        </Grid.RowDefinitions>

        <Label Margin="5" Background="AliceBlue" BorderBrush="Black" BorderThickness="1" HorizontalAlignment="Left" MouseUp="SomethingClicked">
            <StackPanel MouseUp="SomethingClicked">
                <TextBlock Margin="3" MouseUp="SomethingClicked">
                    Image and picture lable
                </TextBlock>
                <Image Source="E:\practice\WPF\WPFDemo\路由事件\Image\face.jpeg" Stretch="None" MouseUp="SomethingClicked"></Image>
                <TextBlock Margin="3" MouseUp="SomethingClicked">
                   Courtesy of the StackPanel
                </TextBlock>
            </StackPanel>
        </Label>

        <ListBox Margin="5" Name="lstMessage" Grid.Row="1"></ListBox>
        <CheckBox Margin="5" Grid.Row="2" Name="chkHandle">Handle first event</CheckBox>
        <Button Click="cmdClear_click" Grid.Row="3" HorizontalAlignment="Right" Margin="5" Padding="3">Clear List</Button>
    </Grid>
</Window>

當(dāng)我們點(diǎn)擊Image的時(shí)候，發(fā)發(fā)生冒泡路由事件，會(huì)一層層的向外傳遞，傳遞順序：Image->StackPanel->Label->Grid->Window。

后端代碼如下：

using System.Windows;

namespace 路由事件
{
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        protected int eventCounter = 0;
        private void SomethingClicked(object sender, RoutedEventArgs e)
        {
            eventCounter++;
            string message = $"#{eventCounter.ToString()}:\r\n" +
                $"Sender:{sender.ToString()}\r\n" +
                $"Source:{e.Source}\r\n" +
                $"Original Source:{e.OriginalSource}";
            lstMessage.Items.Add(message);
            // Handled允許終止事件的冒泡或者終止隧道過(guò)程
            // 設(shè)置Handled=True，事件就不會(huì)繼續(xù)傳遞了
            e.Handled = (bool)chkHandle.IsChecked;
        }

        private void cmdClear_click(object sender, RoutedEventArgs e)
        {
            eventCounter = 0;
            lstMessage.Items.Clear();
        }
    }
}

運(yùn)行程序，輸出結(jié)果如下：

可以看到：輸出結(jié)果就是按照我們上面的順序輸出的。我們把Grid的MouseUp事件去掉，在看輸出結(jié)果：

這時(shí)就沒(méi)有Grid控件了。勾選下面的復(fù)選框，在執(zhí)行結(jié)果：

這時(shí)只有Image控件被觸發(fā)了，其它控件的MouseUp被終止了。

2、隧道路由事件

隧道路由事件跟冒泡路由事件一樣，都是在包含層次中，但是隧道路由事件的傳遞方向跟冒泡路由事件正好相反：隧道路由事件首先是從根元素上被觸發(fā)，然后從每一個(gè)元素向下沿著樹傳遞，直到到達(dá)根元素為止（或者直到到達(dá)處理程序把事件標(biāo)記為已處理為止）。

冒泡路由事件是向上傳遞，隧道路由事件是向下傳遞。

隧道路由事件在事件到達(dá)恰當(dāng)?shù)目丶?，為預(yù)覽事件提供了機(jī)會(huì)。首先是在窗口級(jí)別上，也就是頂級(jí)，然后是更具體的容器，最后直到到達(dá)按下鍵時(shí)具有焦點(diǎn)的元素。我們很容易就可以識(shí)別隧道事件，因?yàn)樗麄兌际且詥卧~Preview開(kāi)頭的。WPF通?？梢猿蓪?duì)的定義冒泡路由事件和隧道路由事件。如果我們找到一個(gè)MouseUp的冒泡路由事件，還可以找到一個(gè)PreviewMouseUp的隧道路由事件。隧道路由事件總是在冒泡路由事件之前被觸發(fā)。

XAML代碼如下；

<Window x:Class="Wpf路由事件管道策略.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="MainWindow" Height="350" Width="525" WindowStartupLocation="CenterScreen" PreviewMouseDown="Window_PreviewMouseDown">
    <Grid x:Name="grid" PreviewMouseDown="grid_PreviewMouseDown">
        <Button Height="30" Width="100" Content="點(diǎn)擊我" PreviewMouseDown="Button_PreviewMouseDown"></Button>
    </Grid>
</Window>

后臺(tái)代碼如下：

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 Wpf路由事件管道策略
{
    /// <summary>
    /// MainWindow.xaml 的交互邏輯
    /// </summary>
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private void Window_PreviewMouseDown(object sender, MouseButtonEventArgs e)
        {
            MessageBox.Show("windows被點(diǎn)擊");
        }

        private void grid_PreviewMouseDown(object sender, MouseButtonEventArgs e)
        {
            MessageBox.Show("grid被點(diǎn)擊");
        }

        private void Button_PreviewMouseDown(object sender, MouseButtonEventArgs e)
        {
            MessageBox.Show("button被點(diǎn)擊");
        }
    }
}

程序運(yùn)行效果：

特別值得注意的是：管道事件按照慣例,他們的名字中都有一個(gè)preview前綴，一般來(lái)說(shuō)管道事件都有他的配對(duì)的冒泡事件，例如：PreviewMouseDown和MouseDown就是配對(duì)事件，如果同時(shí)存在的話，那么就會(huì)先執(zhí)行管道事件然后才執(zhí)行配對(duì)的冒泡事件。當(dāng)然e.Handled=true,依然能夠阻斷事件。

看下面的示例代碼：

<Window x:Class="路由事件.Window1"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:路由事件"
        mc:Ignorable="d"
        Title="隧道路由事件" Height="639" Width="853"
        PreviewKeyDown="SomeKeyPressed">
    <Grid Margin="3" PreviewKeyDown="SomeKeyPressed">
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto"></RowDefinition>
            <RowDefinition Height="*"></RowDefinition>
            <RowDefinition Height="Auto"></RowDefinition>
            <RowDefinition Height="Auto"></RowDefinition>
        </Grid.RowDefinitions>

        <Label Margin="5" Background="AliceBlue" BorderBrush="Black" BorderThickness="1" HorizontalAlignment="Stretch" PreviewKeyDown="SomeKeyPressed">
            <StackPanel PreviewKeyDown="SomeKeyPressed">
                <TextBlock Margin="3" HorizontalAlignment="Center" PreviewKeyDown="SomeKeyPressed">
                    Image and picture lable
                </TextBlock>
                <Image Source="E:\practice\WPF\WPFDemo\路由事件\Image\face.jpeg" HorizontalAlignment="Center" Stretch="None" PreviewKeyDown="SomeKeyPressed"></Image>

                <DockPanel Margin="0,5,0,0" PreviewKeyDown="SomeKeyPressed">
                    <TextBlock Margin="3" PreviewKeyDown="SomeKeyPressed">
                       Type here:
                    </TextBlock>
                    <TextBox PreviewKeyDown="SomeKeyPressed"></TextBox>
                </DockPanel>
            </StackPanel>
        </Label>

        <ListBox Margin="5" Name="lstMessage" Grid.Row="1"></ListBox>
        <CheckBox Margin="5" Grid.Row="2" Name="chkHandle">Handle first event</CheckBox>
        <Button Click="cmdClear_click" Grid.Row="3" HorizontalAlignment="Right" Margin="5" Padding="3">Clear List</Button>
    </Grid>
</Window>

后端事件代碼：

using System.Windows;

namespace 路由事件
{
    /// <summary>
    /// Window1.xaml 的交互邏輯
    /// </summary>
    public partial class Window1 : Window
    {
        public Window1()
        {
            InitializeComponent();
        }

        protected int eventCounter = 0;

        private void SomeKeyPressed(object sender, RoutedEventArgs e)
        {
            eventCounter++;
            string message = $"#{eventCounter.ToString()}:\r\n" +
                $"Sender:{sender.ToString()}\r\n" +
                $"Source:{e.Source}\r\n" +
                $"Original Source:{e.OriginalSource}" +
                $"Event:{e.RoutedEvent}";
            lstMessage.Items.Add(message);
            // Handled允許終止事件的冒泡或者終止隧道過(guò)程
            // 設(shè)置Handled=True，事件就不會(huì)繼續(xù)傳遞了
            e.Handled = (bool)chkHandle.IsChecked;
        }

        private void cmdClear_click(object sender, RoutedEventArgs e)
        {
            eventCounter = 0;
            lstMessage.Items.Clear();
        }
    }
}

運(yùn)行結(jié)果：

可以看到：執(zhí)行順序是從頂級(jí)元素到最里層的元素。

注意：如果要使用冒泡路由事件，只需要將PreviewKeyDown改為KeyDown即可。

3、直接策略

事件僅僅在源元素上觸發(fā)，這個(gè)與普通的.Net事件的行為相同，不同的是這樣的事件仍然會(huì)參與一些路由事件的特定機(jī)制，如事件觸發(fā)器等。

該事件唯一可能的處理程序是與其掛接的委托。

路由事件的事件處理程序的簽名（即方法的參數(shù)）：

他與通用的.net事件處理程序的模式一致，也有兩個(gè)參數(shù)：第一個(gè)為：System.Object對(duì)象，名為sender，第二個(gè)參數(shù)（一般名為e）是一個(gè)派生于System.EventArgs的類。sender參數(shù)就是該處理程序被添加的元素，參數(shù)e是RoutedEventArgs的一個(gè)實(shí)例提供了4個(gè)有用的屬性：

Source---邏輯樹中開(kāi)始觸發(fā)該事件的的元素。
originalSource--可視樹中一開(kāi)始觸發(fā)該事件的元素。
handled---布爾值，設(shè)置為true表示事件已處理，在這里停止。
RoutedEvent---真正的路由事件對(duì)象，（如Button.ClickEvent）當(dāng)一個(gè)事件處理程序同時(shí)用于多個(gè)路由事件時(shí)，它可以有效地識(shí)別被出發(fā)的事件。

以上所述是小編給大家介紹的WPF路由事件中的三種策略，希望對(duì)大家有所幫助。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持！

您可能感興趣的文章: