XL98: How to Trap Events for an Embedded Chart (189055)

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. To trap an event for an embedded chart on a worksheet, use a WithEvents declaration on a class module.

Setting Up a Sample Embedded Chart

To set up a sample embedded chart, follow these steps:

1. Save and close any open workbooks, and then create a new workbook.
2. Type the following data in Sheet1:

   A1: 1
   A2: 2
   A3: 3

3. Select the range A1:A3. On the Insert menu, click Chart.
4. In the "Chart Wizard - Step 1 of 4 - Chart Type" dialog box, and click Finish.

An embedded column chart appears on Sheet1.

Writing the Macro Code

To write the macro code, follow these steps:

1. Start the Visual Basic Editor by pressing OPTION+F11.
2. On the Insert menu, click Class Module.
   
   This step inserts a class module called Class1 into your project.
3. In this class module, type the following code:

          Public WithEvents EmbChart As Chart
   						

   The WithEvents keyword makes the EmbChart variable available in the Object list in the Class1 (Code) module window.
4. In the Class1 (Code) window, click EmbChart in the Object list.
   
   The following code automatically appears in the class module:

          Private Sub EmbChart_Activate()
   
          End Sub
   						

   NOTE: The Activate event is the default event for the object.
5. In the Class1 (Code) window, click Resize in the Procedure list.
   
   The following code automatically appears in the class module:

          Private Sub EmbChart_Resize()
   
          End Sub
   						

6. Type the following code for the Resize event procedure:

          Private Sub EmbChart_Resize()
              MsgBox "You are resizing the " & EmbChart.Name & " chart."
          End Sub
   						

7. On the Insert menu, click Module.
8. In this module, type the following code:

          Dim mychart As New Class1
   
          Sub Set_Chart()
   
              Set mychart.EmbChart = Sheet1.ChartObjects(1).Chart
   
          End Sub
   						

9. Run the Set_Chart macro.
   
   Whenever you resize the chart on Sheet1, a message box displays the message in the EmbChart_Resize subprocedure.
10. To switch to Microsoft Excel, press OPTION+F11.
11. Click once on the embedded chart in Sheet1.
12. Click one of the handles on the border of the chart and drag it in any direction.
    
    A message box appears and displays the following message:
    You are resizing the Sheet1 Chart 1 chart.
13. Click OK.

Disabling the Event Handler

If you close the workbook that contains this project, the event handler is disabled. To programmatically disable the event handler, follow these steps:

1. Start the Visual Basic Editor by pressing OPTION+F11.
2. In the general module in which you typed the Set_Chart macro, type the following macro:

         Sub Reset_Chart()
   
             Set mychart.EmbChart = Nothing
   
         End Sub
   						

3. Run the Reset_Chart macro.
4. On the File menu, click "Close and Return to Microsoft Excel."
5. Select and resize the embedded chart.

The message box does not appear.