WPF路由事件

藍白永恆發表於2022-04-27

理解路由事件

事件路由允許源自某個元素的事件由另一個元素引發。

定義、註冊和包裝路由事件

public class MyWindow : Window
{
	/// <summary>
	/// 定義和註冊路由事件
	/// </summary>
	public static readonly RoutedEvent MyRoutedEvent = EventManager.RegisterRoutedEvent("MyEvent",
		RoutingStrategy.Bubble, typeof(RoutedEventHandler), typeof(MyWindow));

	/// <summary>
	/// 包裝路由事件
	/// </summary>
	public event RoutedEventHandler MyRouted
	{
		add
		{
			base.AddHandler(MyRoutedEvent, value);
		}
		remove
		{
			base.RemoveHandler(MyRoutedEvent, value);
		}
	}
}

共享路由事件

​ 與依賴項屬性一樣,可以在類之間共享路由事件的定義。例如,兩個基類UIElementContentElement類,都使用了MouseUp事件。MouseUp事件是在Windows.Input.Mouse類中定義,通過RoutedEvent.AddOwer()方法重用MouseUp事件。

	UIElement.MouseUpEvent = Mouse.MouseUpEvent.AddOwner(Typeof(UIElement));

觸發路由事件

路由事件的引發不是傳統的.NET事件包裝器引發,而是使用RaiseEvent()方法引發事件,說有UIElement類繼承了該方法。

	RoutedEventArgs e = new RoutedEventArgs(MyRoutedEvent, this);
	base.RaiseEvent(e);

處理路由事件

XAML標記新增事件特性

<local:MyWindow ... 
                MyRouted="MyWindow_MyRouted"
                ... />

通過程式碼連線事件

     this.MyRouted += MainWindow_MyRouted;

	///WPF事件引數類都是繼承自RoutedEventArgs類,可自定義事件引數類來傳遞更多的資訊
	private void MainWindow_MyRouted(object sender, RoutedEventArgs e)
	{
		//do something...
	}

還可以通過呼叫AddHandler()方法連結事件處理器。

	AddHandler(MyRoutedEvent, new RoutedEventHandler((s,e)=>
	{
        //do something...                                                 
	}));	
	或
	AddHandler(MyRoutedEvent, new RoutedEventHandler(Eventhandler));

	private void Eventhandler(object o, RoutedEventArgs e)
	{
		//do something...
	}
	//使用RemoveHandler()方法來移除事件處理器 注:匿名委託不適用
	//當程式多次附加事件處理器時,執行RemoveHandler()方法只刪除一次連線。例如,連線了兩次事件處理程式,刪除了一次連線,觸發事件時事件處理程式執行一次。		連線了三次事件處理程式,刪除了一次連線,觸發事件時事件處理程式執行兩次。
	RemoveHandler(MyRoutedEvent, new RoutedEventHandler(eventhandler));
	或
     MyRouted -= Eventhandler;

事件路由

WPF窗體中的所有要素都一定程度上繼承自UIElement類,WPF中的許多空間都是內容控制元件,繼承自ContentControl,可以在其中多次重複巢狀。

WPF路由事件模型的三種方式:

  • 直接路由事件(Direct Event):與.NET事件類似,它起源於一個元素,並且不傳遞給其他元素。例如,MouseEnter事件是一個直接路由事件。
  • 冒泡路由事件(Bubbling Event):在包含層次中向上傳遞。例如,MouseDown事件就是冒泡路由事件。冒泡順序首先由被單擊的元素引發,接下來被該元素的父元素引發,依次類推,直到WPF元素樹的頂部為止。
  • 隧道路由事件(Tunneling Event):在包含層次中向下傳遞。隧道路由事件在事件到達恰當的控制元件之前為預覽事件(或者可能終止事件)提供機會。例如,通過PreviewKeyDown事件可以截獲是否按下了一個鍵,首先在視窗級別上,然後是更具體的容器,直到到達按下鍵時具有焦點的元素。

路由事件的行為在註冊路由事件的EventManager.RegisterEvent()中定義,傳遞為RoutingStrategy列舉值。

RoutedEventArgs

WPF事件引數類都是繼承自RoutedEventArgs類,可自定義事件引數類來傳遞更多的資訊。RoutedEventArgs類的屬性:

名稱 說明
Source 指示引發事件的物件。對於鍵盤事件,是當事件發生時具有焦點的控制元件。對於滑鼠事件,是當事件發生時滑鼠指標下面所有元素中最上面的元素。
OriginalSource 指示最初是什麼物件引發事件。通常OriginalSource屬性和Source屬性值是相同的。但是在某些情況下,OriginalSource屬性指向物件樹種更深得層次,以獲得作為更高一級元素一部分的後臺元素,事件最原始的源為Border元素,組成在控制元件模板中。
RoutedEvent 通過事件處理程式為觸發的事件提供RoutedEvent物件。如果使用同一事件處理程式處理不同的事件,這一資訊是非常有用得。
Handled 該屬性允許終止事件的冒泡或隧道過程。如果一個控制元件將Handled屬性設定為true,那麼事件將不會繼續傳播。並且也不會再為任何其他元素引發該事件。

冒泡路由事件

<Label MouseUp="Label_MouseUp">
	<Border MouseUp="Border_MouseUp">
		<StackPanel MouseUp="StackPanel_MouseUp">
			<Button Width="100" Height="30"  MouseUp="Button_MouseUp"/>
		</StackPanel>
	</Border>
</Label>
MessageBox.Show("btn"+"\n"+sender.ToString()+ "\n" + e.Source.ToString()+ "\n" + e.OriginalSource.ToString());

在一個容器中放置下列元素,分別給每一個元素的MouseUp事件處理器新增以上程式碼。窗體開啟後右鍵點選按鈕就會依次彈出訊息框,通過訊息框資訊可以看到事件的觸發順序依次是ButtonStackPanelBorderLabel。若在StackPanelMouseUp事件處理器中將e.Handled設定為true時,事件將不會繼續傳播,程式將不會在進入BoderLabel中的MouseUp事件處理器中。

e.Handled = true;

當事件處於掛起時,還可以通過AddHandler()方法,AddHandler()方法提供一個過載版本,在之前的基礎上在傳遞一個bool型別的引數,將引數設定為true時,即使Handled屬性被設定為true也可以接收到事件。

lab.AddHandler(UIElement.MouseUpEvent, new MouseButtonEventHandler(Label_MouseUp), true);

在設計器中刪除Label元素的MouseUp事件特性,在初始化時通過以上程式碼連線事件處理器。當觸發MouseUp時,Label訊息框就會出現。

附加事件

<StackPanel Name="stpBtn" Grid.Row="2" ButtonBase.Click="DoSomething">
	<Button Width="100" Height="30" />
	<Button Width="100" Height="30" Margin="0,10" />
	<Button Width="100" Height="30" />
</StackPanel>

以上程式碼在StackPanel元素中關聯Button元素的點選事件,當點選其中按鈕時就會進圖DoSomething()方法,通過類名.事件命關聯事件。Click事件是在ButtonBase中定義,Button繼承自ButtonBase。附加事件還可以通過以下方式連線:

//關聯附加事件只能用UIElement.AddHandler()方法 不能用 += 運算子
stpBtn.AddHandler(Button.ClickEvent, new RoutedEventHandler(DoSomething));

隧道事件

隧道路由事件的工作方式和冒泡路由事件相同,但方向相反。隧道路由事件一般有Preview開頭,WPF通常成對的定義隧道路由事件通常和冒泡事件。如果將隧道路由事件標記為已處理過(e.Handled=true),那麼就不會發生冒泡路由事件,這是因為兩個事件共享RoutedEventArgs的同一個例項。

WPF事件

WPF元素提供了許多事件,但最重要的事件通常包括5類,生命週期事件、滑鼠事件、鍵盤事件、手寫筆事件、多點觸控事件。

相關文章