Bubble Event Handler of the User Control for the parent control

2011-02-28

5493
0
ASP.NET
2013-07-08

最近剛好投入在開發Win Form程式的開發，雖然離開發Win Form程式已經好久時段了，

不過還好有些觀念的東西沒有忘記，所以最近剛好被問到一個問題：

「如何把User Control裡某物件觸發的事件通知上層使用它的人，讓上層的Control可以擷取到裡面的內容？」

關於這個問題，我想對於.NET Framework中的事件模型運作的流程比較熟悉的話，不難解決這個問題，

其實我自己在撰寫Transport Hub Lite時，也有透過Silverlight實作相似的功能，因此，以下先解釋一下Event Handler。

〉Event Handler：

要了解Event Handler在整個事件處理過程扮演的角色為何，一定要先了解整個.NET Framework在事件模型(Event Model)的運作機制。

在事件運作裡，主要有二個角色：事件發行者(Publisher)與事件訂閱者(Subscriber)。事件發行者，通常識為引發(Raise)事件的類別，

而負責處理(Handle)事件的類別識為事件訂閱者。舉例來說：通常在Form裡針對TextBox註冊一個TextChanged的事件時，如果沒有特

別針對該事件指定其他Event Handler來處理，則該Form則具有二者身份。

根據MSDN針對事件(Event)的概觀定義，如下：

發行者會判斷引發事件的時間，而訂閱者則決定要採取什麼動作來回應該事件。
一個事件可以有多個訂閱者，訂閱者可以處理來自多個發行者的多個事件。
沒有訂閱者的事件永遠不會被呼叫。
事件通常用於對使用者的動作 (例如在圖形化使用者介面內按一下按鈕或選取功能表) 發出信號。
當某事件擁有多個訂閱者時，便會在事件引發的同時叫用事件處理常式。若要以非同步方式叫用事件，請參閱以非同步的方式呼叫同步方法。
事件可用來讓執行緒同步。
在 .NET Framework 類別庫 (Class Library) 中，事件會根據 EventHandler 委派 (Delegate) 和 EventArgs 基底類別 (Base Class)。

至於怎麼訂閱想要處理的事件呢，可以使用如下的方式：

‧訂閱事件 (使用加法指派運算子 (+=)，將事件處理常式附加到事件上)

publisher.RaiseCustomEvent += HandleCustomEvent;
		
//舉例
		
button1.Click += new EventHandler(MyEventHandler);

‧取消事件 (使用減法指派運算子 (-=) 取消訂閱事件)

publisher.RaiseCustomEvent -= HandleCustomEvent;
		
//舉例
		
button1.Click -= MyEventHandler;

從上述的說明，可以了解事件整個運作的裡需要的二個角色與如何掛上更多的Handler來進行事件處理。

然而，事件是一種機制，提供讓應用程式可以針對特定的事件配合指定的程式碼來進行處理，當然，隨著事件的種類不同，

也有包括事件發生前或事件發生後的處理事件等。因此，事件模型依照著事件發行者被引發(raise)的時機，引動對應的訂閱者，

讓註冊的事件處理方法可以完。

那事件被引發時，事件方法是怎麼被啟動的呢？在事件被引發時，事件發行者會通知事件處理常式(Event Handler)，並且事件處理常式

透過委派(delegate)的方式，將事件轉向註冊的執行方法上，完成指定的任務。然而，事件處理常式會被加入到事件中，讓它在引發事件時，

可以依據上述說明的方式呼叫指定的方法。

那要怎麼宣告一個事件在自訂的類別裡呢？那要先了解一個關鍵字：event：

‧event關鍵字：

event關鍵字用於發行者(Publisher)類別中宣告事件。定義該發行者類別具有可對外的事件。

事件是一種特殊種類的多點傳委派(所以允許註冊多個event handler來處理指定的事件)，只能從它們宣告的類別(publisher)或結構(struct)內叫用。

因此，當其他類別向該publisher類別註冊事件處理常式時，event定義的事件會將其處理常式標記起來，等到事件引入時再呼叫處理常式來運作。

另外，event關鍵字可以配合修飾詞的使用(例如：static、virtual、sealed與abstract)，讓事件呈現不同的使用功能，也支援透過override的方式，

讓事件的行動更多元。

//使用範例
		
public event EventHandler gCustomEventHandler;

〉範例

舉個例子來說明實作的效果。假設目前有實作一個User Control(叫MyPanel)，並且裡面放了一個TextBox與具有TextChanged的事件，

最後該User Control被放置於主Form中，當用戶輸入在TextBox輸入內容時，外層Form要能擷取出來。

實作說明：

(a) 在User Control宣告一個用event關鍵字定義的Event Handler，用於定義該User Control是整個Event的發行者(Publisher)；

(b) 在TextChange事件裡，透過Event Handler進行Delegate，轉換事件給由Form向User Control註冊的Event Handler；

‧MyPanel.cs(實作User Control，增加event關鍵字宣告的Event Handler)

public partial class MyPanel : UserControl, IUserControl
		
{
		
    //利用event關鍵字宣告一個Event Handler，提供給外部控件註冊該Event Handler
		
    public event EventHandler TextBox_Change;
		
  
		
    public MyPanel()
		
    {
		
        InitializeComponent();
		
        
		
        //為textBox1註冊TextChanged事件
		
        this.textBox1.TextChanged += new EventHandler(this.textBox1_TextChanged);
		
    }
		
  
		
    private void textBox1_TextChanged(object sender, EventArgs e)
		
    {
		
        //取得由event關鍵字宣告的Event Handler
		
        EventHandler tChangeHandle = this.TextBox_Change;
		
        if (tChangeHandle != null)
		
        {
		
            //利用Delegate轉出該Event給註冊於TextBox_Change的Event Handler
		
            tChangeHandle .Invoke(sender, e);
		
        }
		
    }
		
}

‧Form1.cs(使用MyPanel.cs，並且向MyPanel.cs提供的Event Handler進行註冊)

public partial class Form1 : Form
		
{
		
    public Form1()
		
    {
		
        InitializeComponent();
		
        Init();
		
    }
		
    
		
    private void Init()
		
    {
		
        //實作MyPanel
		
        MyPanel tMyPanel = new MyPanel();
		
        tMyPanel.TextBox_Change += new EventHandler(this.ChangeTextBox);
		
        this.Controls.Add(tMyPanel);
		
        tMyPanel.Show();
		
    }
		
  
		
    protected void ChangeTextBox(object sender, EventArgs e)
		
    {
		
        //取得由MyPanel中TextBox輸入的內容
		
        string tContent = ((TextBox)sender).Text;
		
    }
		
}