Declares a user-defined event.
Syntax
[Public] Event procedurename [(arglist)]
The Event statement has these parts:
| Part | Description |
|---|---|
| Public | Optional. Specifies that the Event visible throughout the project. Events types are Public by default. Note that events can only be raised in the module in which they are declared. |
| procedurename | Required. Name of the event; follows standard variable naming conventions. |
The arglist argument has the following syntax and parts:
[ByVal | ByRef] varname[( )] [As type]
| Part | Description |
|---|---|
| ByVal | Optional. Indicates that the argument is passed by value. |
| ByRef | Optional. Indicates that the argument is passed by reference. ByRef is the default in Visual Basic. |
| varname | Required. Name of the variable representing the argument being passed to the procedure; follows standard variable naming conventions. |
| type | Optional. Data type of the argument passed to the procedure; may be Byte, Boolean, Integer, Long, Currency, Single, Double, Decimal (not currently supported), Date, String (variable length only), Object, Variant, a user-defined type, or an object type. |
Remarks
Once the event has been declared, use the RaiseEvent statement to fire the event. A syntax error occurs if an Event declaration appears in a standard module. An event can't be declared to return a value. A typical event might be declared and raised as shown in the following fragments:
' Declare an event at module level of a class module
Event LogonCompleted (UserName as String)
Sub
RaiseEvent LogonCompleted("AntoineJan")
End Sub
Note You can declare event arguments just as you do arguments of procedures, with the following exceptions: events cannot have named arguments, Optional arguments, or ParamArray arguments. Events do not have return values.