9. Event Programming

Levels of Events

Earlier in the book, you read about workbook events and you have seen examples of worksheet events. Events are Excel’s way of letting you execute code based on certain actions that take place in a workbook.

These events can be found at the following levels:

• Application level—Control based on application actions such as Application_NewWorkbook

• Workbook level—Control based on workbook actions such as Workbook_Open

• Worksheet level—Control based on worksheet actions such as Worksheet_SelectionChange

• Chart sheet level—Control based on chart actions such as Chart_Activate

Listed here are where different types of events should be placed:

• Workbook events go into the ThisWorkbook module.

• Worksheet events go into the module of the sheet they affect such as Sheet1.

• Chart sheet events go into the module of the chart sheet they affect such as Chart1.

• Embedded charts and application events go into class modules.

The events can still make procedure or function calls outside their own modules. Therefore, if you want the same action to take place for two different sheets, you don’t have to copy the code. Instead, place the code in a module and have each sheet event call the procedure.

In this chapter, you learn about different levels of events, where to find them, and how to use the events.

Using Events

Each level consists of several types of events, and memorizing the syntax of them all would be a feat. Excel makes it easy to view and insert the available events in their proper modules right from the VB Editor.

When a ThisWorkbook, Sheet, Chart Sheet, or Class module is active, the corresponding events are available through the Object and Procedure drop-downs, as shown in Figure 9.1.

Figure 9.1. The different events are easy to access from the VB Editor Object and Procedure drop-downs.

After the object is selected, the Procedure drop-down updates to list the events available for that object. Selecting a procedure automatically places the procedure header (Private Sub) and footer (End Sub) in the editor, as shown in Figure 9.2.

Figure 9.2. The procedure header and footer are automatically placed.

Event Parameters

Some events have parameters, such as Target or Cancel, that allow values to be passed into the procedure. For example, some procedures are triggered before the actual event, such as BeforeRightClick. Assigning True to the Cancel parameter prevents the default action from taking place. In this case, the shortcut menu is prevented from appearing:

Private Sub Worksheet_BeforeRightClick(ByVal Target As Range, Cancel As _
Boolean)
Cancel = True
End Sub

Enabling Events

Some events can trigger other events including themselves. For example, the Worksheet_Change event is triggered by a change in a cell. If the event is triggered and the procedure itself changes a cell, the event gets triggered again, which changes a cell, triggering another the event, and so on. The procedure gets stuck in an endless loop.

To prevent this, disable the events and then reenable them at the end of the procedure:

Private Sub Worksheet_Change(ByVal Target As Range)
Application.EnableEvents = False
Range("A1").Value = Target.Value
Application.EnableEvents = True
End Sub

Workbook Events

The following event procedures are available at the workbook level. Some events, such as Workbook_SheetActivate, are sheet events available at the workbook level. This means you don’t have to copy and paste the code in each sheet in which you want it to run.

Workbook_Activate()

Workbook_Activate occurs when the workbook containing this event becomes the active workbook.

Workbook_Deactivate()

Workbook_Deactivate occurs when the active workbook is switched from the workbook containing the event to another workbook.

Workbook_Open()

Workbook_Open is the default workbook event. This procedure is activated when a workbook is opened; no user interface is required. The procedure has a variety of uses, such as checking the username and then customizing the user’s privileges in the workbook.

The following code checks the UserName. If it is not Admin, this code protects each sheet from user changes.

Private Sub Workbook_Open()
Dim sht As Worksheet
If Application.UserName <> "Admin" Then
    For Each sht In Worksheets
        sht.Protect UserInterfaceOnly:=True
    Next sht
End If
End Sub

You can also use Workbook_Open to create custom menus or toolbars. The following code adds the menu MrExcel Programs to the Add-ins tab with two options underneath it (see Figure 9.3).

Figure 9.3. You can use the Open event to create custom menus under the Add-ins tab.

Workbook_BeforeSave(ByVal SaveAsUI As Boolean, Cancel As Boolean)

Workbook_BeforeSave occurs when the workbook is saved. SaveAsUI is set to True if the Save As dialog box is to be displayed. Cancel set to True prevents the workbook from being saved.

Workbook_BeforePrint(Cancel As Boolean)

Workbook_BeforePrint occurs when any print command is used, whether it is in the ribbon, keyboard, or macro. Cancel set to True prevents the workbook from being printed.

The following code tracks each time a sheet is printed. It logs the date, time, username, and the sheet printed in a hidden print log (see Figure 9.4):

Figure 9.4. Use the BeforePrint event to keep a hidden print log in a workbook.

You also can use the BeforePrint event to add information to a header or footer before the sheet is printed. Although you can enter the file path into a header or footer through the Page Setup, before Office XP the only way to add the file path was with code. In legacy versions of Office, the following code was commonly used:

Workbook_BeforeClose(Cancel As Boolean)

Workbook_BeforeClose occurs when a workbook is closed. Cancel set to True prevents the workbook from closing.

If the Open event is used to create a custom menu, the BeforeClose event is used to delete it:

This is a nice little procedure, but there is one problem: If changes are made to the workbook and it isn’t saved, Excel displays the Do You Want to Save? dialog box after the BeforeClose event has run. This means that if the user decides to cancel, the menu is now gone.

The solution is to create your own Save dialog in the event:

Workbook_NewSheet(ByVal Sh As Object)

Workbook_NewSheet occurs when a new sheet is added to the active workbook. Sh is the new Worksheet or Chart Sheet object.

Workbook_WindowResize(ByVal Wn As Window)

Workbook_WindowResize occurs when the active workbook is resized. Wn is the window.

This code disables the resizing of the active workbook:

Private Sub Workbook_WindowResize(ByVal Wn As Window)
Wn.EnableResize = False
End Sub

Workbook_WindowActivate(ByVal Wn As Window)

Workbook_WindowActivate occurs when any workbook window is activated. Wn is the window. Only activating the workbook window starts this event.

Workbook_WindowDeactivate(ByVal Wn As Window)

Workbook_WindowDeactivate occurs when any workbook window is deactivated. Wn is the window. Only deactivating the workbook window starts this event.

Workbook_AddInInstall()

Workbook_AddInInstall occurs when the workbook is installed as an add-in (by selecting the Microsoft Office button, Excel Options, Add-ins). Double-clicking an XLAM file (an add-in) to open it does not activate the event.

Workbook_AddInUninstall

Workbook_AddInUninstall occurs when the workbook (add-in) is uninstalled. The add-in is not automatically closed.

Workbook_Sync(ByVal SyncEventType As Office.MsoSyncEventType)

Workbook_Sync occurs when the local copy of a sheet in a workbook that is part of a Document Workspace is synchronized with the copy on the server. SyncEventType is the status of the synchronization.

Workbook_PivotTableCloseConnection(ByVal Target As PivotTable)

Workbook_PivotTableCloseConnection occurs when a pivot table report closes its connection to its data source. Target is the pivot table that has closed the connection.

Workbook_PivotTableOpenConnection(ByVal Target As PivotTable)

Workbook_PivotTableOpenConnection occurs when a pivot table report opens a connection to its data source. Target is pivot table that has opened the connection.

Workbook_RowsetComplete(ByVal Description As String, ByVal Sheet As String, ByVal Success As Boolean)

Workbook_RowsetComplete occurs when the user drills through a recordset or calls upon the rowset action on an OLAP PivotTable. Description is a description of the event; Sheet is the name of the sheet on which the recordset is created; Success indicates success or failure.

Workbook_BeforeXmlExport(ByVal Map As XmlMap, ByVal Url As String, Cancel As Boolean)

Workbook_BeforeXmlExport occurs when XML data is exported or saved. Map is the map used to export or save the data; Url is the location of the XML file; Cancel set to True cancels the export operation.

Workbook_AfterXmlExport(ByVal Map As XmlMap, ByVal Url As String, ByVal Result As XlXmlExportResult)

Workbook_AfterXmlExport occurs after XML data is exported or saved. Map is the map used to export or save the data; Url is the location of the XML file; Result indicates success or failure.

Workbook_BeforeXmlImport(ByVal Map As XmlMap, ByVal Url As String, ByVal IsRefresh As Boolean, Cancel As Boolean)

Workbook_BeforeXmlImport occurs when XML data is imported or refreshed. Map is the map used to import the data; Url is the location of the XML file; IsRefresh returns True if the event was triggered by refreshing an existing connection and False if triggered by importing from a new data source; Cancel set to True cancels the import or refresh operation.

Workbook_AfterXmlImport(ByVal Map As XmlMap, ByVal IsRefresh As Boolean, ByVal Result As XlXmlImportResult)

Workbook_AfterXmlImport occurs when XML data is exported or saved. Map is the map used to export or save the data; IsRefresh returns True if the event was triggered by refreshing an existing connection and False if triggered by importing from a new data source; Result indicates success or failure.

Workbook Level Sheet and Chart Events

The following are sheet and chart events available at the workbook level. These events affect all sheets in the workbook. Unless otherwise indicated, to affect a specific sheet, replace the text Workbook_Sheet with Worksheet_ or Chart_ to access the sheet or chart level event. For example, if the event is Workbook_SheetSelectionChange, the sheet level event is Worksheet_SelectChange. This does not apply to pivot table events.

Workbook_SheetActivate(ByVal Sh As Object)

Workbook_SheetActivate occurs when any chart sheet or worksheet in the workbook is activated. Sh is the active sheet.

Workbook_SheetBeforeDoubleClick (ByVal Sh As Object, ByVal Target As Range, Cancel As Boolean)

Workbook_SheetBeforeDoubleClick occurs when the user double-clicks any chart sheet or worksheet in the active workbook. Sh is the active sheet; Target is the object double-clicked; Cancel set to True prevents the default action from taking place.

Workbook_SheetBeforeRightClick(ByVal Sh As Object, ByVal Target As Range, Cancel As Boolean)

Workbook_SheetBeforeRightClick occurs when the user right-clicks any worksheet in the active workbook. Sh is the active worksheet; Target is the object right-clicked; Cancel set to True prevents the default action from taking place.

Workbook_SheetCalculate(ByVal Sh As Object)

Workbook_SheetCalculate occurs when any worksheet is recalculated or any updated data is plotted on a chart. Sh is the active sheet.

Workbook_SheetChange (ByVal Sh As Object, ByVal Target As Range)

Workbook_SheetChange occurs when any range in a worksheet is changed. Sh is the worksheet; Target is the changed range.

There is no Chart version of this event.

Workbook_SheetDeactivate (ByVal Sh As Object)

Workbook_SheetDeactivate occurs when any chart sheet or worksheet in the workbook is deactivated. Sh is the sheet being switched from.

Workbook_SheetFollowHyperlink (ByVal Sh As Object, ByVal Target As Hyperlink)

Workbook_SheetFollowHyperlink occurs when any hyperlink is clicked in Excel. Sh is the active worksheet; Target is the hyperlink.

There is no Chart version of this event.

Workbook_SheetSelectionChange(ByVal Sh As Object, ByVal Target As Range)

Workbook_SheetSelectionChange occurs when a new range is selected on any sheet. Sh is the active sheet; Target is the affected range.

There is no Chart version of this event.

Workbook_SheetPivotTableUpdate(ByVal Sh As Object, ByVal Target As PivotTable)

Workbook_SheetPivotTableUpdate occurs when a pivot table is updated. Sh is the active sheet; Target is the updated pivot table.

Worksheet Events

The following event procedures are available at the worksheet level.

Worksheet_Activate()

Worksheet_Activate occurs when the sheet on which the event is located becomes the active sheet.

Worksheet_Deactivate()

Worksheet_Deactivate occurs when another sheet becomes the active sheet.

Worksheet_BeforeDoubleClick(ByVal Target As Range, Cancel As Boolean)

Worksheet_BeforeDoubleClick allows control over what happens when the user double-clicks the sheet. Target is the selected range on the sheet; Cancel is set to False by default, but if set to True, it prevents the default action, such as entering a cell, from happening.

The following code prevents the user from entering a cell with a double-click. In addition, if the formula field is hidden, this code does not allow the user to enter information in the traditional way:

Private Sub Worksheet_BeforeDoubleClick(ByVal Target As Range, _
    Cancel As Boolean)
Cancel = True
End Sub

Preventing the double-click from entering a cell allows it to be used for something else such as highlighting a cell. The following code changes a cell’s interior color to red when it is double-clicked:

Private Sub Worksheet_BeforeDoubleClick(ByVal Target As Range, _
    Cancel As Boolean)
Dim myColor As Integer
Target.Interior.ColorIndex = 3
End Sub

Worksheet_BeforeRightClick(ByVal Target As Range, Cancel As Boolean)

Worksheet_BeforeRightClick is triggered when the user right-clicks a range. Target is the object right-clicked; Cancel set to True prevents the default action from taking place.

Worksheet_Calculate()

Worksheet_Calculate occurs after a sheet is recalculated.

The following example compares a month’s profits between the previous and current year. If profit has fallen, a red down arrow appears below the month; if profit has risen, a green up arrow appears (see Figure 9.5):

Figure 9.5. Use the Calculate event to add graphics that emphasize the change in profits.

Worksheet_Change(ByVal Target As Range)

Worksheet_Change is triggered by a change to a cell’s value such as when text is entered, edited, or deleted. Target is the cell that has been changed.

Worksheet_SelectionChange(ByVal Target As Range)

Worksheet_SelectionChange occurs when a new range is selected. Target is the newly selected range.

The following example helps identify a single selected cell by highlighting the row and column:

Worksheet_FollowHyperlink(ByVal Target As Hyperlink)

Worksheet_FollowHyperlink occurs when a hyperlink is clicked. Target is the hyperlink.

Worksheet_PivotTableUpdate(ByVal Target As PivotTable)

Worksheet_PivotTableUpdate occurs when a pivot table is updated. Target is the updated pivot table.

Chart Sheet Events

Chart events occur when a chart is changed or activated. Embedded charts require the use of class modules to access the events. For more information about class modules, see Chapter 22, “Creating Classes, Records, and Collections.”

Embedded Charts

Because embedded charts do not create chart sheets, the chart events are not as readily available. However, you can make them available by adding a class module, as follows:

1. Insert a class module.
2. Rename the module to cl_ChartEvents.
3. Enter the following line of code in the class module:

   Public WithEvents myChartClass As Chart
   

   The chart events are now available to the chart, as shown in Figure 9.6. They are accessed in the class module rather than on a chart sheet.

   

   Figure 9.6. Embedded chart events are now available in the class module.

4. Insert a standard module.
5. Enter the following lines of code in a standard module:

   Dim myClassModule As New cl_ChartEvents
   Sub InitializeChart()
       Set myClassModule.myChartClass = _
          Worksheets(1).ChartObjects(1).Chart
   End Sub
   

These lines initialize the embedded chart to be recognized as a Chart object. The procedure must be run once per session.

Chart_Activate()

Chart_Activate occurs when a chart sheet is activated or changed.

Chart_BeforeDoubleClick(ByVal ElementID As Long, ByVal Arg1 As Long, ByVal Arg2 As Long, Cancel As Boolean)

Chart_BeforeDoubleClick occurs when any part of a chart is double-clicked. ElementID is the part of the chart that is double-clicked, such as the legend. Arg1 and Arg2 are dependent upon the ElementID; Cancel set to True prevents the default double-click action from occurring.

The following sample hides the legend when it is double-clicked, while double-clicking either axis brings back the legend:

Chart_BeforeRightClick(Cancel As Boolean)

Chart_BeforeRightClick occurs when a chart is right-clicked. Cancel set to True prevents the default right-click action from occurring.

Chart_Calculate()

Chart_Calculate occurs when a chart’s data is changed.

Chart_Deactivate()

Chart_Deactivate occurs when another sheet becomes the active sheet.

Chart_MouseDown(ByVal Button As Long, ByVal Shift As Long, ByVal x As Long, ByVal y As Long)

Chart_MouseDown occurs when the cursor is over the chart and any mouse button is pressed. Button is the mouse button that was clicked; Shift is whether a Shift, Ctrl, or Alt key was pressed; X is the X coordinate of the cursor when the button is pressed; Y is the Y coordinate of the cursor when the button is pressed.

The following code zooms in on a left mouse click and zooms out on a right mouse click. Use the Cancel argument in the BeforeRightClick event to handle the menus that appear when you right-click a chart.

Chart_MouseMove(ByVal Button As Long, ByVal Shift As Long, ByVal x As Long, ByVal y As Long)

Chart_MouseMove occurs as the cursor is moved over a chart. Button is the mouse button being held down, if any; Shift is whether a Shift, Ctrl, or Alt key was pressed; X is the X coordinate of the cursor on the chart; Y is the Y coordinate of the cursor on the chart.

Chart_MouseUp(ByVal Button As Long, ByVal Shift As Long, ByVal x As Long, ByVal y As Long)

Chart_MouseUp occurs when any mouse button is released while the cursor is on the chart. Button is the mouse button that was clicked; Shift is whether a Shift, Ctrl, or Alt key was pressed; X is the X coordinate of the cursor when the button is released; Y is the Y coordinate of the cursor when the button is released.

Chart_Resize()

Chart_Resize occurs when a chart is resized using the sizing handles. However, this does not occur when the size is changed using the size control on the Format tab of the chart tools.

Chart_Select(ByVal ElementID As Long, ByVal Arg1 As Long, ByVal Arg2 As Long)

Chart_Select occurs when a chart element is selected. ElementID is the part of the chart selected such as the legend. Arg1 and Arg2 are dependent upon the ElementID.

The following code highlights the data set when a point on the chart is selected—assuming the series starts in A1 and each row is a point to plot—as shown in Figure 9.7:

Figure 9.7. Use the Chart_Select event to highlight the data used to create a point on the chart.

Chart_SeriesChange(ByVal SeriesIndex As Long, ByVal PointIndex As Long)

Chart_SeriesChange occurs when a chart data point is updated. SeriesIndex is the offset in the Series collection of updated series; PointIndex is the offset in the Point collection of updated point.

Chart_DragOver()

Chart_DragOver occurs when a range is dragged over to a chart. This event no longer works in Excel 2007 or Excel 2010. However, a program using it will compile for use in legacy versions of Excel.

Chart_DragPlot()

Chart_DragPlot occurs when a range is dragged and dropped on a chart. This event no longer works in Excel 2007 or Excel 2010. However, a program using it will compile for use in legacy versions of Excel.

Application-Level Events

Application-level events affect all open workbooks in an Excel session. They require a class module to access them. This is similar to the class module used to access events for embedded chart events. Follow these steps to create the class module:

1. Insert a class module.
2. Rename the module cl_AppEvents.
3. Enter the following line of code in the class module:

   Public WithEvents AppEvent As Application
   

   The application events are now available to the workbook as shown in Figure 9.8. They are accessed in the class module rather than in a standard module.

   

   Figure 9.8. Application events are now available through the class module.

4. Insert a standard module.
5. Enter the following lines of code in the standard module:

   Dim myAppEvent As New cl_AppEvents
   Sub InitializeAppEvent()
       Set myAppEvent.AppEvent = Application
   End Sub
   

These lines initialize the application to recognize application events. The procedure must be run once per session.

AppEvent_AfterCalculate()

AppEvent_AfterCalculate occurs after all calculations are complete and there aren’t any outstanding queries or incomplete calculations.

AppEvent_NewWorkbook(ByVal Wb As Workbook)

AppEvent_NewWorkbook occurs when a new workbook is created. Wb is the new workbook. The following code arranges the open workbooks in a tiled configuration:

Private Sub AppEvent_NewWorkbook(ByVal Wb As Workbook)
    Application.Windows.Arrange xlArrangeStyleTiled
End Sub

AppEvent_ProtectedViewWindowActivate(ByVal Pvw As ProtectedViewWindow)

ProtectedViewWindowActivate occurs when a workbook in Protected View mode is activated. PVW is the workbook being activated.

AppEvent_ProtectedViewWindowBeforeClose(ByVal Pvw As ProtectedViewWindow, ByVal Reason As XlProtectedViewCloseReason, Cancel As Boolean)

ProtectedViewWindowBeforeClose occurs when a workbook in Protected View mode is closed. PVW is the workbook being deactivated; Reason is why the workbook closed; Cancel set to True prevents the workbook from closing.

AppEvent_ProtectedViewWindowDeactivate(ByVal Pvw As ProtectedViewWindow)

ProtectedViewWindowDeactivate occurs when a workbook in Protected View mode is deactivated. PVW is the workbook being deactivated.

AppEvent_ProtectedViewWindowOpen(ByVal Pvw As ProtectedViewWindow)

ProtectedViewWindowOpen occurs when a workbook is open in Protected View mode. PVW is the workbook being opened.

AppEvent_ProtectedViewWindowResize(ByVal Pvw As ProtectedViewWindow)

ProtectedViewWindowResize occurs when the window of the protected workbook is resized. However, this does not occur in the application itself. PVW is the workbook being resized.

AppEvent_SheetActivate (ByVal Sh As Object)

AppEvent_SheetActivate occurs when a sheet is activated. Sh is the worksheet or chart sheet.

AppEvent_SheetBeforeDoubleClick(ByVal Sh As Object, ByVal Target As Range, Cancel As Boolean)

AppEvent_SheetBeforeDoubleClick occurs when the user double-clicks a worksheet. Target is the selected range on the sheet; Cancel is set to False by default. However, when set to True, it prevents the default action such as entering a cell from happening.

AppEvent_SheetBeforeRightClick(ByVal Sh As Object, ByVal Target As Range, Cancel As Boolean)

AppEvent_SheetBeforeRightClick occurs when the user right-clicks any worksheet. Sh is the active worksheet; Target is the object right-clicked; Cancel set to True prevents the default action from taking place.

AppEvent_SheetCalculate(ByVal Sh As Object)

AppEvent_SheetCalculate occurs when any worksheet is recalculated or any updated data is plotted on a chart. Sh is the active sheet.

AppEvent_SheetChange(ByVal Sh As Object, ByVal Target As Range)

AppEvent_SheetChange occurs when the value of any cell is changed. Sh is the worksheet; Target is the changed range.

AppEvent_SheetDeactivate(ByVal Sh As Object)

AppEvent_SheetDeactivate occurs when any chart sheet or worksheet in a workbook is deactivated. Sh is the sheet being deactivated.

AppEvent_SheetFollowHyperlink(ByVal Sh As Object, ByVal Target As Hyperlink)

AppEvent_SheetFollowHyperlink occurs when any hyperlink is clicked in Excel. Sh is the active worksheet; Target is the hyperlink.

AppEvent_SheetSelectionChange(ByVal Sh As Object, ByVal Target As Range)

AppEvent_SheetSelectionChange occurs when a new range is selected on any sheet. Sh is the active sheet; Target is the selected range.

AppEvent_SheetPivotTableUpdate(ByVal Sh As Object, ByVal Target As PivotTable)

AppEvent_SheetPivotTableUpdate occurs when a pivot table is updated. Sh is the active sheet; Target is the updated pivot table.

AppEvent_WindowActivate(ByVal Wb As Workbook, ByVal Wn As Window)

AppEvent_WindowActivate occurs when any workbook window is activated. Wb is the workbook being deactivated; Wn is the window. Works only if there are multiple windows.

AppEvent_WindowDeactivate(ByVal Wb As Workbook, ByVal Wn As Window)

AppEvent_WindowDeactivate occurs when any workbook window is deactivated. Wb is the active workbook; Wn is the window. Works only if there are multiple windows.

AppEvent_WindowResize(ByVal Wb As Workbook, ByVal Wn As Window)

AppEvent_WindowResize occurs when the active workbook is resized. Wb is the active workbook; Wn is the window. Works only if there are multiple windows.

AppEvent_WorkbookActivate(ByVal Wb As Workbook)

AppEvent_WorkbookActivate occurs when any workbook is activated. Wn is the window. The following sample maximizes any workbook when it is activated:

Private Sub AppEvent_WorkbookActivate(ByVal Wb as Workbook)
    Wb.WindowState = xlMaximized
End Sub

AppEvent_WorkbookAddinInstall(ByVal Wb As Workbook)

AppEvent_WorkbookAddinInstall occurs when a workbook is installed as an add-in (File, Options, Add-ins). Double-clicking an XLAM file to open it does not activate the event. Wb is the workbook being installed.

AppEvent_WorkbookAddinUninstall(ByVal Wb As Workbook)

AppEvent_WorkbookAddinUninstall occurs when a workbook (add-in) is uninstalled. The add-in is not automatically closed. Wb is the workbook being uninstalled.

AppEvent_WorkbookBeforeClose(ByVal Wb As Workbook, Cancel As Boolean)

AppEvent_WorkbookBeforeClose occurs when a workbook closes. Wb is the workbook; Cancel set to True prevents the workbook from closing.

AppEvent_WorkbookBeforePrint(ByVal Wb As Workbook, Cancel As Boolean)

AppEvent_WorkbookBeforePrint occurs when any print command is used (via the ribbon, keyboard, or a macro). Wb is the workbook; Cancel set to True prevents the workbook from being printed.

The following code places the username in the footer of the active sheet printed:

Private Sub AppEvent_WorkbookBeforePrint(ByVal Wb As Workbook, _
    Cancel As Boolean)
Wb.ActiveSheet.PageSetup.LeftFooter = Application.UserName
End Sub

AppEvent_WorkbookBeforeSave(ByVal Wb As Workbook, ByVal SaveAsUI As Boolean, Cancel As Boolean)

AppEvent_Workbook_BeforeSave occurs when the workbook is saved. Wb is the workbook; SaveAsUI is set to True if the Save As dialog box is to be displayed; Cancel set to True prevents the workbook from being saved.

AppEvent_WorkbookNewSheet(ByVal Wb As Workbook, ByVal Sh As Object)

AppEvent_WorkbookNewSheet occurs when a new sheet is added to the active workbook. Wb is the workbook; Sh is the new worksheet or chart sheet object.

AppEvent_WorkbookOpen(ByVal Wb As Workbook)

AppEvent_WorkbookOpen occurs when a workbook is opened. Wb is the workbook that was just opened.

AppEvent_WorkbookPivotTableCloseConnection(ByVal Wb As Workbook, ByVal Target As PivotTable)

AppEvent_PivotTableCloseConnection occurs when a pivot table report closes its connection to its data source. Wb is the workbook containing the pivot table that triggered the event; Target is pivot table that has closed the connection.

AppEvent_WorkbookPivotTableOpenConnection(ByVal Wb As Workbook, ByVal Target As PivotTable)

AppEvent_PivotTableOpenConnection occurs when a pivot table report opens a connection to its data source. Wb is the workbook containing the pivot table that triggered the event; Target is the pivot table that has opened the connection.

AppEvent_WorkbookRowsetComplete(ByVal Wb As Workbook, ByVal Description As String, ByVal Sheet As String, ByVal Success As Boolean)

AppEvent_RowsetComplete occurs when the user drills through a recordset or calls upon the rowset action on an OLAP pivot table. Wb is the workbook that triggered the event; Description is a description of the event; Sheet is the name of the sheet on which the recordset is created; Success indicates success or failure.

AppEvent_WorkbookSync(ByVal Wb As Workbook, ByVal SyncEventType As Office.MsoSyncEventType)

AppEvent_Workbook_Sync occurs when the local copy of a sheet in a workbook that is part of a Document Workspace is synchronized with the copy on the server. Wb is the workbook that triggered the event; SyncEventType is the status of the synchronization.

AppEvent_WorkbookBeforeXmlExport(ByVal Wb As Workbook, ByVal Map As XmlMap, ByVal Url As String, Cancel As Boolean)

AppEvent_WorkbookBeforeXmlExport occurs when XML data is exported or saved. Wb is the workbook that triggered the event; Map is the map used to export or save the data; Url is the location of the XML file; Cancel set to True cancels the export operation.

AppEvent_WorkbookAfterXmlExport(ByVal Wb As Workbook, ByVal Map As XmlMap, ByVal Url As String, ByVal Result As XlXmlExportResult)

AppEvent_WorkbookAfterXmlExport occurs after XML data is exported or saved. Wb is the workbook that triggered the event; Map is the map used to export or save the data; Url is the location of the XML file; Result indicates success or failure.

AppEvent_WorkbookBeforeXmlImport(ByVal Wb As Workbook, ByVal Map As XmlMap, ByVal Url As String, ByVal IsRefresh As Boolean, Cancel As Boolean)

AppEvent_WorkbookBeforeXmlImport occurs when XML data is imported or refreshed. Wb is the workbook that triggered the event; Map is the map used to import the data; Url is the location of the XML file; IsRefresh returns True if the event was triggered by refreshing an existing connection and False if triggered by importing from a new data source; Cancel set to True cancels the import or refresh operation.

AppEvent_WorkbookAfterXmlImport(ByVal Wb As Workbook, ByVal Map As XmlMap, ByVal IsRefresh As Boolean, ByVal Result As XlXmlImportResult)

AppEvent_WorkbookAfterXmlImport occurs when XML data is exported or saved. Wb is the workbook that triggered the event; Map is the map used to export or save the data; IsRefresh returns True if the event was triggered by refreshing an existing connection and False if triggered by importing from a new data source; Result indicates success or failure.

Next Steps

In this chapter, you learned more about interfacing with Excel. Chapter 10 introduces you to tools you can use to interact with users. You learn how to prompt users for information to use in your code, warn them of illegal actions, or provide them with an interface to work with other than the spreadsheet.