Private Sub Form_Unload()
Remarks
To run a macro or event procedure when these events occur, set the OnUnload property to the name of the macro or to [Event Procedure].
The Unload event is caused by user actions such as:
- Clicking a Form window's Close button or clicking Close on the File menu or a form's Control menu.
- Running the Close
action in a macro.
- Quitting an application by right-clicking the application's taskbar button and then clicking Close.
- Quitting Windows while an application is running.
By running a macro or an event procedure when a form's Unload event occurs, you can verify that the form should be unloaded or specify actions that should take place when the form is unloaded. You can also open another form or display a dialog box requesting the user's name to make a log entry indicating who used the form.
When you close a form, the following events occur in this order:
Unload → Deactivate → Close
The Unload event occurs before the Close event. The Unload event can be canceled, but the Close event can't.
Note When you create macros or event procedures for events related to the Load event, such as Activate and GotFocus, be sure that they don't conflict (for example, make sure you don't cause something to happen in one macro or procedure that is canceled in another) and that they don't cause cascading events.
Example
This example prompts the user to verify that the form should close.
To try the example, add the following event procedure to a form. In Form view, close the form to display the dialog box, and then click Yes or No.
Private Sub Form_Unload(Cancel As Integer)
If MsgBox("Close form?", vbYesNo) = vbYes Then
Exit Sub
Else
Cancel = True
End If
End Sub