Closing a Custom Form or UserForm by Pressing the Escape Key, Excel VBA

It is possible to close a custom form by pressing any key, such as . To do this, you simply need to write code that handles the KeyDown event, explicitly identify the required key, and close the form using the Unload or End statement. The KeyDown event has two parameters: the first returns the code of the pressed key, and the second identifies the modifier key pressed. VBA has a special constant vbKeyEscape for the Escape key code. The following code, placed in the custom form’s module, closes the window when the Escape key is pressed:

Private Sub UserForm_KeyDown(ByVal KeyCode As MSForms.ReturnInteger, _
    ByVal Shift As Integer)
        If KeyCode = vbKeyEscape Then
            Unload Me
        End If
End Sub

Comments

• The KeyDown and KeyUp events occur sequentially when you press and then release a key.
  • The KeyDown event occurs when a key is pressed.
  • The KeyUp event occurs when a key is released.

Syntax:

Private Sub Object_KeyDown(ByVal KeyCode As MSForms.ReturnInteger, ByVal Shift As fmShiftState)
Private Sub Object_KeyUp(ByVal KeyCode As MSForms.ReturnInteger, ByVal Shift As fmShiftState)

These event syntaxes include the following elements:

Table: Shift Parameter Constants

You can use the following KeyCode constants anywhere in your code instead of numeric values: