逐步解說：宣告和引發事件

發行項
08/21/2008

更新：2007 年 11 月

本逐步解說會示範如何宣告和引發名為 Widget 之類別的事件。在您完成步驟後，可能會想要閱讀相關主題，請參閱逐步解說：處理事件，這個主題會顯示如何使用 Widget 物件的事件，提供應用程式的狀態資訊。

假設此刻您有一個 Widget 類別。這個 Widget 類別具有需花長時間執行的方法，而您希望應用程式能夠建立某種完成指示器 (Indicator)。

當然可以讓 Widget 物件顯示完成百分比對話方塊，但之後在每個使用 Widget 類別的專案中，您都會停在那個對話方塊上動彈不得。除非該物件的目的就是在管理表單或對話方塊，否則良好的物件設計原則應該要能夠讓使用物件的應用程式處理使用者介面。

Widget 的目的是要執行其他工作，所以最好加入 PercentDone 事件，讓呼叫 Widget 方法的程序處理該事件並顯示狀態更新。PercentDone 事件也可以提供取消工作的機制。

若要建立此主題的程式碼範例

開啟新的 Visual Basic Windows 應用程式專案，並建立名為 Form1 的表單。
將兩個按鈕和一個標籤 (Label) 加入至 Form1。
如下表所示，為物件命名。

物件

屬性

設定

Button1

Text

Start Task

Button2

Text

Cancel

Label

(Name), Text

lblPercentDone, 0
從 [專案] 功能表，選擇 [加入類別] 將名為 Widget.vb 的類別加入至專案。

物件	屬性	設定
Button1	Text	Start Task
Button2	Text	Cancel
Label	(Name), Text	lblPercentDone, 0

使用 Event 關鍵字宣告 Widget 類別中的事件。請注意，事件可以具有 ByVal 和 ByRef 引數，如 Widget 的 PercentDone 事件所示：
```
Public Event PercentDone(ByVal Percent As Single, _
                         ByRef Cancel As Boolean)
```

當呼叫物件收到 PercentDone 事件時，Percent 引數會包含已完成工作的百分比。可以將 Cancel 引數設定為 True，取消引發事件的方法。

注意事項：
宣告事件引數的方式就如同您宣告程序的引數一樣，除了以下不同之外：事件不得有 Optional 或 ParamArray 引數，以及事件沒有傳回值。

Widget 類別的 LongTask 方法會引發 PercentDone 事件。LongTask 採用兩個引數：方法假裝進行工作的時間長度，以及在 LongTask 停頓之前引發 PercentDone 事件的最短時間間隔。

若要引發 PercentDone 事件

若要簡化對此類別所使用之 Timer 屬性的存取，可以在 Class Widget 陳述式上方的類別模組宣告區段最上方，加入一個 Imports 陳述式。
```
Imports Microsoft.VisualBasic.DateAndTime
```

將下列程式碼加入至 Widget 類別：

Public Sub LongTask(ByVal Duration As Single, _
                    ByVal MinimumInterval As Single)
    Dim Threshold As Single
    Dim Start As Single
    Dim blnCancel As Boolean

    ' The Timer property of the DateAndTime object returns the seconds
    ' and milliseconds that have passed since midnight.
    Start = CSng(Timer)
    Threshold = MinimumInterval

    Do While CSng(Timer) < (Start + Duration)
        ' In a real application, some unit of work would
        ' be done here each time through the loop.
        If CSng(Timer) > (Start + Threshold) Then
            RaiseEvent PercentDone( _
            Threshold / Duration, blnCancel)
            ' Check to see if the operation was canceled.
            If blnCancel Then Exit Sub
            Threshold = Threshold + MinimumInterval
        End If
    Loop
End Sub

當應用程式呼叫 LongTask 方法時，Widget 類別會每隔 MinimumInterval 秒引發 PercentDone 事件。當事件傳回時，LongTask 會檢查 Cancel 引數是否設為 True。

此處需要提出一些免責聲明。為容易了解，LongTask 程序假設您事先知道工作將花費的時間。這種情況幾乎很少發生。將工作分割為數個大小相同的區塊 (Chunk) 是相當困難的，且通常對使用者而言最重要的是他們獲知事情發生之前所經過的時間量。

您可能發現本範例還有另一個瑕疵。Timer 屬性會傳回從午夜起算的秒數，因此，如果是在午夜之前啟動，應用程式就會停住不動。較謹慎地計算時間的方法是設定界限條件，例如將這個情況納入考慮，或是使用像 Now 這類屬性以避免問題的發生。

現在 Widget 類別可以引發事件，您可以移到下一個逐步解說。逐步解說：處理事件會示範如何使用 WithEvents，建立事件處理常式與 PercentDone 事件的關聯。

請參閱

共用方式為

逐步解說：宣告和引發事件

Widget 類別

若要建立此主題的程式碼範例

若要宣告 Widget 類別的事件

若要引發 PercentDone 事件

請參閱

工作

概念

參考

其他資源