XL98: How to Use EnableEvents to Disable Event Handling

MORE INFORMATION

Microsoft provides programming examples for illustration only, without warranty either expressed or implied. This includes, but is not limited to, the implied warranties of merchantability or fitness for a particular purpose. This article assumes that you are familiar with the programming language that is being demonstrated and with the tools that are used to create and to debug procedures. Microsoft support engineers can help explain the functionality of a particular procedure, but they will not modify these examples to provide added functionality or construct procedures to meet your specific requirements.

Creating a Sample Event Procedure

In this example you set up a Visual Basic for Applications macro that responds to the SelectionChange event in a worksheet. To set up the event handler, follow these steps:

1. Close and save any open workbooks, and then create a new workbook.
2. Start the Visual Basic Editor (press OPTION+F11).
3. If the Project Explorer window is not visible, click Project Explorer on the View menu.
4. Double-click Sheet1 to open the Code window for Sheet1.
5. In the Code window for Sheet1, enter the following code for the SelectionChange event:

         Private Sub Worksheet_SelectionChange(ByVal Target As Excel.Range)
             MsgBox Target.Address
         End Sub
   						

6. Switch to Microsoft Excel (press OPTION+F11).
7. Click any cell on Sheet1.

When you click a cell on Sheet1, a message box displays the cell address of the selected cell.

Using a Procedure to Run the Event Handler

The following sample macro runs the event handler. To set up the macro, follow these steps:

1. Start the Visual Basic Editor (press OPTION+F11).
2. On the Insert menu, click Module.
3. Enter the following code into the Visual Basic module:

         Sub FireEvent()
             Dim X as Integer
             For X = 1 To 5
                 Cells(X, 1).Select
             Next X
         End Sub
   						

4. Switch to Microsoft Excel (press OPTION+F11).
5. On the Tools menu, point to Macro, and then click Macros. Then, click FireEvent and click Run.

A message box appears every time the FireEvent macro selects a cell on Sheet1.

Preventing the Event Procedure from Running

To prevent an event handler from running while a macro is running, set the EnableEvents property to False. To use the EnableEvents property in an example, follow these steps:

1. Start the Visual Basic Editor (press OPTION+F11).
2. On the Insert menu, click Module.
3. Type the following macro in the module:

         Sub DisableEvent()
            Dim X As Integer
   
            ' Disable all event firing.
            Application.EnableEvents = False
   
            For X = 1 To 5
               Cells(X, 1).Select
            Next X
   
            ' Re-enable all event firing.
            Application.EnableEvents = True
         End Sub
   						

4. Switch to Microsoft Excel (press OPTION+F11).
5. On the Tools menu, point to Macro, and click Macros. Then, click DisableEvent and click Run.

No message boxes appear during the execution of the macro. This indicates that the SelectionChange event is not running. If you select another cell on Sheet1 after the DisableEvent macro is finished running, the event handler is active again and a message box appears.

NOTE: If you do not set the EnableEvents property to True before your macro finishes running, events are disabled. If you set the EnableEvents property to False, make sure that you set it back to True.