Instrução Event

Declara um evento definido pelo usuário.

[ <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

Partes

Comentários

Depois que o evento foi declarado, use a instrução RaiseEvent para levantar o evento. Um evento típico pode ser declarado e levantado conforme os seguintes fragmentos:

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

Para manipular um evento, você deve associá-lo com um manipulador de eventos sub-rotina usando a instrução Handles ou AddHandler. As assinaturas de sub-rotina e o evento devem coincidir. Para manipular um evento compartilhado, você deve usar a instrução AddHandler.

Você pode usar Event somente no nível de módulo. Isso significa que o contexto da declaração para um evento deve ser uma classe, estrutura, módulo, procedimento ou interface, e não pode ser um arquivo fonte, namespace, procedimento ou bloco. Para obter mais informações, consulte Contextos de declaração e níveis de acesso padrão (Visual Basic).

Na maioria das circunstâncias, você pode usar a primeira sintaxe na seção Sintaxe deste tópico para declarar eventos. No entanto, alguns cenários requerem que você tenha mais controle sobre o comportamento detalhado de evento. A última sintaxe na seção Sintaxe neste tópico, que usa a palavra-chave Custom , fornece esse controle permitindo que você defina eventos personalizados. Em um evento personalizado, você especifica exatamente o que ocorre quando o código adiciona ou remove um manipulador de eventos para ou a partir do evento, ou quando o código gera o evento. Para exemplos, veja Como declarar eventos personalizados para conservar memória (Visual Basic) e Como declarar eventos personalizados para evitar bloqueio (Visual Basic).

Exemplo

O exemplo a seguir usa os eventos com a contagem regressiva de segundos de 10 a 0. O código ilustra vários dos métodos relacionados a eventos, propriedades e instruções. Isso inclui a instrução RaiseEvent.

A classe que gera um evento é a origem de evento, e os métodos que processam o evento são os manipuladores de eventos. Uma fonte de eventos pode ter vários manipuladores para eventos que ela gera. Quando a classe gera o evento, esse evento é gerado em cada classe que decidiu manipular eventos para essa instância do objeto.

O exemplo também usa um formulário (Form1) com um botão (Button1) e um caixa de texto (TextBox1). Quando você clica no botão, a primeira caixa de texto exibe uma contagem regressiva de 10 para 0 segundos. Quando o tempo total (10 segundos) tiver decorrido, a primeira caixa de texto exibe "Concluído".

O código Form1 especifica os estados do formulário inicial e de terminal. Ele também contém o código executado quando os eventos são gerados.

Para usar esse exemplo, abra um novo projeto Formulários do Windows. Em seguida, adicione um botão chamado Button1 e um caixa de texto chamado TextBox1 ao formulário principal, chamado Form1. Em seguida, clique com o botão direito do mouse no formulário e clique em Exibir código para abrir a editor de códigos.

Adicione uma variável WithEvents à seção declarações da classe Form1:

Private WithEvents mText As TimerState

Adicione o seguinte código para o evento Form1 . Substituir qualquer procedimentos duplicados que podem existir, como Form_Load ou Button_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

Pressione F5 para executar o exemplo anterior e clique no botão rotulado como Iniciar . A primeira caixa de texto inicia a contagem regressiva de segundos. Quando o tempo total (10 segundos) tiver decorrido, a primeira caixa de texto exibe "Concluído".

Consulte também

Tarefas

Como declarar eventos personalizados para conservar memória (Visual Basic)

Como declarar eventos personalizados para evitar bloqueio (Visual Basic)

Referência

Instrução RaiseEvent

Instrução Implements

Instrução AddHandler

Instrução RemoveHandler

Cláusula Handles (Visual Basic)

Instrução Delegate

Compartilhado (Visual Basic)

Sombras (Visual Basic)

Outros recursos

Eventos (Visual Basic)