Name
RaiseEvent Statement
Syntax
RaiseEventeventName([arglist])
-
eventName
Use: Required
Data Type: String literal
The name of the event
-
arglist
Use: Optional
Data Type: Any (defined by the
Event
statement)A comma-delimited list of arguments
Description
Generates a predefined, custom event within any procedure of an object module
Rules at a Glance
eventName
must already be defined in the Declarations section of the module using theEvent
statement.arglist
must match the number and data type of parameters defined in theEvent
statement and must be surrounded by parentheses.The
RaiseEvent
andEvent
statements can only be used in object modules and not in code modules.
Example
The following code snippet demonstrates how you can use an event to
communicate a status message back to the client application and, at
the same time, use a ByRef
argument to trap a user
response in the client application. This gets around the fact that
events can’t return values. To take advantage of this
functionality, the client must declare a reference to this class
using the WithEvents
keyword.
Public Class CTransact Public Event Status(Message As String, _ ByRef Cancel As Boolean) Public Function UpdateRecords(iVal As Integer) as Boolean Dim blnCancel As Boolean = False If iVal > 1000 Then RaiseEvent Status("Is value too high?", blnCancel) If blnCancel Then Console.WriteLine("Abandoning operation...") Exit Function Else iVal = 1000 End If End If console.writeline(iVal) End Function End Class Module modMain Public ...
Get VB .NET Language in a Nutshell now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.