C#中事件的使用

用一個例子來說明事件的使用。

建立一個簡單的類，名為FileWatch，包含事件OnfileChange。該類將檢查在執行應用程式的目錄（當前

目錄，通常是項目名/bin/debug)下，是否存在檔案test.txt。如果檔案被刪除或建立，都將觸發事件。

同時提供一個方法MonitorFile以不斷地查詢該檔案。

方法：

在建立一個可用事件之前，首先聲明一個委託，放在類的外面。
public delegate void FileWatchEventHandler(object sender,EventArgs e);

接下來建立類FileWatch。然後聲明事件，注意事件的類型即為我們之前定義的委託。

public event FileWatchEventHandler FileWatchEvent;

現在建立方法OnFileChange()，當調用該方法時將觸發事件：

protected virtual void OnFileChange(EventArgs e)
{
     if (FileWatchEvent!=null)
     {
         FileWatchEvent(this,e);
     }
}

最後，建立方法MonitorFile()，

public void MonitorFile()
{
    bool bCurrentStatus;
   
    while(true)
    {
         bCurrentStatus = File.Exists("test.txt");
         if (bCurrentStatus != _bLastStatus) //_bLastStatus為私人欄位，初始值為false;
         {
             _bLastStatus = bCurrentStatus;
             OnFileChange(EventArgs.Empty);
         }

         Thread.Sleep(250);
    }
}

完整代碼如下：

using System;
using System.Threading; 
using System.IO;      

namespace Sample.Event
{ 

      public delegate void FileWatchEventHandler(object sender, EventArgs e); 

      public class FileWatch
      {
            private bool _bLastStatus = false;
            public FileWatch()
            {
                  //
                  // TODO: 在此處添加建構函式邏輯
                  //
            } 

            public event FileWatchEventHandler FileWatchEvent; 

            protected virtual void OnFileChange(EventArgs e)
            {
                  if (FileWatchEvent != null)
                  {
                       
                        FileWatchEvent(this, e);
                  }
            } 

            public void MonitorFile()
            {
                  bool bCurrentStatus; 

                  while(true)
                  {
                        bCurrentStatus = File.Exists("test.txt");

                        //狀態不符，說明檔案被刪除或重新建立，此時觸發事件；
                        if ( bCurrentStatus != _bLastStatus )
                        {
                              _bLastStatus = bCurrentStatus;
                              OnFileChange( EventArgs.Empty );
                        } 

                       
                        Thread.Sleep(250);
                  } 

            }
      }
}

使用：建立一個Windows應用程式來測試我們之前建立的FileWatch中的事件。首先將剛才建立的項目編譯

，產生Assembly：FileWatch.dll，然後添加引用。當然直接添加項目引用也可以。然後在Windows應用程

序中加入命名空間：

using Sample.Event;

然後在應用程式類中，定義一個私人欄位，類型為我們之前建立的類FileWatch：
public class frmMain : System.Windows.Forms.Form
      {
            private Sample.Event.FileWatch FileWatchEventSource;

並在建構函式中執行個體化該對象；

public frmMain()
            {
                 
                  InitializeComponent();
                 

                  FileWatchEventSource = new Sample.Event.FileWatch();

然後將本地方法OnFileChange串連到事件中：

FileWatchEventSource.FileWatchEvent+=new Sample.Event.FileWatchEventHandler(OnFileChange);

我們需要調用MonitorFile方法來觸發事件。在本例中，我們用線程來控制MonitorFile方法。這樣可以在

應用程式閑置的時候運行該方法以觸發事件。

thrd = new Thread(new ThreadStart(FileWatchEventSource.MonitorFile));
thrd.Start();

最後，我們需要知道事件是否被觸發，為了記錄下事件觸發的記錄，我們在ListBox控制項添加觸發內

容。由於事件觸發後調用的方法是OnFileChange，因此我們將操作放在該方法裡：

private void OnFileChange(object Sender, EventArgs e)
{
   listBox.Items.Add(DateTime.Now.ToString()+": 檔案發生改變.");
}

當觸發事件時，EventHanler會傳遞sender和EventArgs類的引用。EventArgs類通常是在事件來源和觸發事

件器之間傳遞資訊。在本例中，沒有傳遞資訊，也沒有用到EventArgs類。而只是將事件添加到了ListBox

中。

運行結果如下：

 

結論：在C#中使用事件的要點：

首先，要建立委託，格式為：
public delegate void 委託名(object sender, EventArgs e);
注意：委託即C裡的函數指標，在事件中由於要傳遞事件及觸發事件的對象的資訊，因此參數表是固定的。委託名一般格式是：名字+EnvenHandle。這樣取名比較規範。

然後，建立一個事件欄位：
public event 委託類型 事件名；
注意：event關鍵字代表事件，傳回型別為委託；

再定義一個方法，處理事件，再本例中為OnFileChange（EventArgs e)。在該方法中應該呼叫事件：
事件名（object ,EventArgs)；
這裡object一般為本身，實參應為this，EventArgs應為OnFileChange中傳遞過來的實參，尤其是要傳遞事件的值。

最後還要建立觸發事件的方法。例子中為MonitorFile()，在其方法中，當條件滿足則調用OnFileChange來達到觸發事件的目的。

再使用事件時，通常要定義兩個方法，一個是和事件定義的委託簽名一致的方法，在本例中為OnFileChange(Object sender,EventArgs e)；

注意在例子中，表單類的OnFileChange和事件類別的OnFileChange是不同的。後者用於呼叫事件，前者則用於綁定事件。綁定事件的方法很簡單，用+=表示添加事件，-=表示刪除事件。
例子中
FileWatchEventSource.FileWatchEvent+=new Sample.Event.FileWatchEventHandler(OnFileChange);
即為添加事件。

例子中：首先線程啟動（thd.Start()），然後調用MonitorFile()方法。引起事件產生，FileWatchEvent產生後，由於我們將事件FileWatchEvent綁定到了OnFileChange()方法上。因而調用本地即視窗類別的OnFileChange()方法，從而實現在ListBox中添加資訊。