Event 陳述式

宣告使用者定義的事件。

Syntax

[ <attrlist> ] [ accessmodifier ] _  
[ Shared ] [ Shadows ] Event eventname[(parameterlist)] _  
[ Implements implementslist ]  
' -or-  
[ <attrlist> ] [ accessmodifier ] _  
[ Shared ] [ Shadows ] Event eventname As delegatename _  
[ Implements implementslist ]  
' -or-  
 [ <attrlist> ] [ accessmodifier ] _  
[ Shared ] [ Shadows ] Custom Event eventname As delegatename _  
[ Implements implementslist ]  
   [ <attrlist> ] AddHandler(ByVal value As delegatename)  
      [ statements ]  
   End AddHandler  
   [ <attrlist> ] RemoveHandler(ByVal value As delegatename)  
      [ statements ]  
   End RemoveHandler  
   [ <attrlist> ] RaiseEvent(delegatesignature)  
      [ statements ]  
   End RaiseEvent  
End Event  

組件

部分 描述
attrlist 選擇性。 套用至此事件的屬性清單。 以逗號分隔多個屬性。 您必須將 屬性清單 放在角括弧中 ( " < " 和 " > " ) 。
accessmodifier 選擇性。 指定哪些程式碼可以存取此事件。 可以是下列其中一項:

- Public:任何可存取宣告專案的程式碼都可以存取它。
- Protected-只有其類別或衍生類別中的程式碼可以存取它。
- Friend—只有相同元件中的程式碼可以存取它。
- 用—只有在宣告它的元素中的程式碼可以存取它。
- 在事件的類別、衍生類別或相同元件中,受保護的僅限 Friend 程式碼可以存取它。
- 在事件的類別或相同元件中的衍生類別中,僅限私用受保護的程式碼可以存取它。
Shared 選擇性。 指定此事件與類別或結構的特定執行個體不相關。
Shadows 選擇性。 指出這個事件會在基底類別中重新宣告並隱藏相同名稱的程式設計項目,或一組多載項目。 您可以使用任何其他類型遮蔽任何一種已宣告的項目。

無法從遮蔽項目的衍生類別內使用遮蔽的項目,除了從無法存取遮蔽項目的位置以外。 例如,如果 Private 項目會遮蔽基底類別項目,沒有 Private 項目存取權限的程式碼會改為存取基底類別項目。
eventname 必要。 事件的名稱;依照標準變數命名慣例。
parameterlist 選擇性。 本機變數清單,表示此事件的參數。 您必須將 參數清單 括在括弧中。
Implements 選擇性。 指出此事件會實作介面的事件。
implementslist 如果使用 Implements,則為必要項。 實作之 Sub 程序的清單。 以逗號分隔多個程序:

implementedprocedure [, implementedprocedure ...]

每個 implementedprocedure 都具有下列語法和組件:

interface.definedname

- interface 必. 介面名稱,該介面實作包含類別或結構的此程序。
- Definedname 必. 名稱,據以在 interface 中定義程序。 不一定要與 name 相同,這是此程序用來實作已定義程序的名稱。
Custom 必要。 事件宣告為 Custom 必須定義自訂 AddHandlerRemoveHandlerRaiseEvent 存取子。
delegatename 選擇性。 委派的名稱,指定事件處理常式簽章。
AddHandler 必要。 宣告 AddHandler 存取子,指定加入事件處理常式時要執行的陳述式,可以明確地使用 AddHandler 陳述式或隱含地使用 Handles 子句。
End AddHandler 必要。 終止 AddHandler 區塊。
value 必要。 參數名稱。
RemoveHandler 必要。 宣告 RemoveHandler 存取子,指定使用 RemoveHandler 陳述式移除事件處理常式時要執行的陳述式。
End RemoveHandler 必要。 終止 RemoveHandler 區塊。
RaiseEvent 必要。 宣告 RaiseEvent 存取子,指定使用 RaiseEvent 陳述式引發事件處理常式時要執行的陳述式。 一般而言,這樣會叫用 AddHandlerRemoveHandler 存取子所維護的委派。
End RaiseEvent 必要。 終止 RaiseEvent 區塊。
delegatesignature 必要。 參數的清單,符合 delegatename 委派所需的參數。 您必須將 參數清單 括在括弧中。
statements 選擇性。 陳述式,包含 AddHandlerRemoveHandlerRaiseEvent 方法的內文。
End Event 必要。 終止 Event 區塊。

備註

一旦已經宣告事件,使用 RaiseEvent 陳述式來引發事件。 一般事件可能會如下列片段所示宣告和引發:

Public Class EventSource
    ' Declare an event.
    Public Event LogonCompleted(ByVal UserName As String)
    Sub CauseEvent()
        ' Raise an event on successful logon.
        RaiseEvent LogonCompleted("AustinSteele")
    End Sub
End Class

注意

您可以宣告事件引數,就像宣告程序的引數一樣,但下列情況除外:事件不可擁有具名引數、ParamArray 引數或 Optional 引數。 事件沒有傳回值。

若要處理事件,您必須使用 HandlesAddHandler 陳述式,建立它與事件處理常式副程式的關聯。 副程式與事件的簽章必須相符。 若要處理共用的事件,您必須使用 AddHandler 陳述式。

您只能在模組層級使用 Event。 這表示事件的宣告 內容 必須是類別、結構、模組或介面,且不能是原始程式檔、命名空間、程式或區塊。 如需詳細資訊,請參閱宣告內容和預設存取層級

在大部分情況下,您可以使用本主題「語法」一節中的第一個語法來宣告事件。 不過,某些情況下需要您對詳細事件行為有更多掌控。 本主題中「語法」一節中的最後一個語法使用 Custom 關鍵字,藉由讓您定義自訂事件以提供控制權。 在自訂事件中,您完整指定當程式碼於事件中加入或移除事件處理常式,或是當程式碼引發事件時,會發生什麼情況。 如需範例,請參閱 如何:宣告自訂事件以節省記憶體如何:宣告自訂事件以避免封鎖

範例

下列範例會使用事件以從 10 秒到 0 秒倒數計時。 程式碼會說明數個事件相關的方法、屬性和陳述式。 包括 RaiseEvent 陳述式。

引發事件的類別是事件來源,處理事件的方法為事件處理常式。 事件來源對於它所產生的事件可以有多個處理常式。 當類別引發事件時,該事件是在每個類別 (已被選擇來處理該物件執行個體的事件) 上引發。

此範例也會使用表單 (Form1) 與按鈕 (Button1) 和文字方塊 (TextBox1)。 當您按一下按鈕時時,第一個文字方塊會顯示從 10 秒到 0 秒的倒數計時。 在經過完整時間 (10 秒) 之後,第一個文字方塊會顯示 [完成]。

Form1 的程式碼會指定表單的初始和終止狀態。 它也包含引發事件時執行的程式碼。

若要使用此範例,請建立新的 Windows Form 專案。 然後新增一個名為 Button1 的按鈕,和名為 TextBox1 的文字方塊到名為 Form1 的主表單中。 然後以滑鼠右鍵按一下表單,然後按一下 [ 流覽程式碼 ] 以開啟程式碼編輯器。

WithEvents 變數加入至 Form1 類別的宣告區段:

Private WithEvents mText As TimerState

將下列程式碼加入至 Form1 的程式碼。 取代可能存在的任何重複程序,例如 Form_LoadButton_Click

Private Sub Form1_Load() Handles MyBase.Load
    Button1.Text = "Start"
    mText = New TimerState
End Sub
Private Sub Button1_Click() Handles Button1.Click
    mText.StartCountdown(10.0, 0.1)
End Sub

Private Sub mText_ChangeText() Handles mText.Finished
    TextBox1.Text = "Done"
End Sub

Private Sub mText_UpdateTime(ByVal Countdown As Double
  ) Handles mText.UpdateTime

    TextBox1.Text = Format(Countdown, "##0.0")
    ' Use DoEvents to allow the display to refresh.
    My.Application.DoEvents()
End Sub

Class TimerState
    Public Event UpdateTime(ByVal Countdown As Double)
    Public Event Finished()
    Public Sub StartCountdown(ByVal Duration As Double,
                              ByVal Increment As Double)
        Dim Start As Double = DateAndTime.Timer
        Dim ElapsedTime As Double = 0

        Dim SoFar As Double = 0
        Do While ElapsedTime < Duration
            If ElapsedTime > SoFar + Increment Then
                SoFar += Increment
                RaiseEvent UpdateTime(Duration - SoFar)
            End If
            ElapsedTime = DateAndTime.Timer - Start
        Loop
        RaiseEvent Finished()
    End Sub
End Class

按 F5 執行上述範例,然後按一下標示為 [ 開始] 的按鈕。 第一個文字方塊會開始倒數計時。 在經過完整時間 (10 秒) 之後,第一個文字方塊會顯示 [完成]。

注意

My.Application.DoEvents 方法不會以與表單相同的方式處理事件。 若要啟用表單以直接處理事件,您可以使用多執行緒。 如需詳細資訊,請參閱 Managed 執行緒

另請參閱