Declaração RaiseEvent

  • Artigo

Aciona um evento declarado no nível do módulo dentro de uma classe, formulário ou documento.

Sintaxe

RaiseEvent eventname[( argumentlist )]

Partes

eventname
Obrigatório. Nome do evento a ser acionado.

argumentlist
Opcional. Lista delimitada por vírgulas de variáveis, matrizes ou expressões. O argumentlist argumento deve ser colocado entre parênteses. Se não houver argumentos, os parênteses devem ser omitidos.

Observações

O necessário eventname é o nome de um evento declarado dentro do módulo. Ele segue as convenções de nomenclatura de variáveis do Visual Basic.

Se o evento não tiver sido declarado dentro do módulo no qual ele é gerado, ocorrerá um erro. O fragmento de código a seguir ilustra uma declaração de evento e um procedimento no qual o evento é gerado.

' Declare an event at module level.
Event LogonCompleted(ByVal UserName As String)

Sub Logon(ByVal UserName As String)
    ' Raise the event.
    RaiseEvent LogonCompleted(UserName)
End Sub

Você não pode usar RaiseEvent para gerar eventos que não são explicitamente declarados no módulo. Por exemplo, todos os formulários herdam um Click evento de System.Windows.Forms.Form, ele não pode ser gerado usando RaiseEvent em um formulário derivado. Se você declarar um Click evento no módulo de formulário, ele sombreará o próprio Click evento do formulário. Você ainda pode invocar o evento do Click formulário chamando o OnClick método.

Por padrão, um evento definido no Visual Basic gera seus manipuladores de eventos na ordem em que as conexões são estabelecidas. Como os eventos podem ter ByRef parâmetros, um processo que se conecta tardiamente pode receber parâmetros que foram alterados por um manipulador de eventos anterior. Depois que os manipuladores de eventos são executados, o controle é retornado para a sub-rotina que gerou o evento.

Nota

Eventos não compartilhados não devem ser gerados dentro do construtor da classe na qual são declarados. Embora esses eventos não causem erros em tempo de execução, eles podem não ser capturados pelos manipuladores de eventos associados. Use o Shared modificador para criar um evento compartilhado se você precisar gerar um evento de um construtor.

Nota

Você pode alterar o comportamento padrão dos eventos definindo um evento personalizado. Para eventos personalizados, a RaiseEvent instrução invoca o acessador do RaiseEvent evento. Para obter mais informações sobre eventos personalizados, consulte Declaração de evento.

Exemplo 1

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

A classe que gera um evento é a fonte do 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 os eventos que gera. Quando a classe gera o evento, esse evento é gerado em cada classe que optou por manipular eventos para essa instância do objeto.

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

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

Para usar este exemplo, abra um novo projeto de aplicativo do Windows, adicione um botão chamado Button1 e uma caixa de texto nomeada 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 o Editor de códigos.

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

Private WithEvents mText As TimerState

Exemplo 2

Adicione o seguinte código ao código de Form1. Substitua quaisquer procedimentos duplicados que possam 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 Iniciar. A primeira caixa de texto começa a contar os segundos. Quando o tempo completo (10 segundos) tiver decorrido, a primeira caixa de texto exibirá "Concluído".

Nota

O My.Application.DoEvents método não processa eventos exatamente da mesma maneira que o formulário. Para permitir que o formulário manipule os eventos diretamente, você pode usar multithreading. Para obter mais informações, consulte Threading gerenciado.

Consulte também