Using Call to Run VBA Macros

While it is possible to run a VBA macro from another macro by using the approach presented in the previous tip, there are times when such an approach just won't do the job. Instead, you need to look for a solution that allows a fail-safe method of running a macro. One approach is to use the Call command in VBA. Before you can use the command, however, you need to add a project reference to the calling project. (Projects are how VBA refers to the collection of VBA modules, forms, etc. in a template. For example, VBA refers to the Normal.dot template as the "Normal" project.) References between projects provide an unambiguous defined link between a calling project and the project to be called.

For instance, let's say that the MyMacro macro (the one you wanted to run) was a part of the CoolDoc template. To use Call properly in VBA, you need to add a reference to the CoolDoc.dot project to the macro that will call MyMacro. Unfortunately, this is a bit easier said than done because of a potential "gottcha" in VBA: Other than the "Normal" project, VBA gives all user-created template projects the default project name of "TemplateProject." This can create problems since having a unique project name is best when wishing be specific about the macro to run. To give CoolDoc.dot a unique project name, follow these steps:

1. Make sure the CoolDoc.dot template is open.
2. Display the VBA editor by pressing Alt+F11.
3. In the Project window at the upper-left of the VBA editor, right-click on the folder for the template. The folder will be named either Project (CoolDoc). Word displays a Context menu.
4. Choose the Project Properties option from the Context menu. The Properties dialog box is displayed.
5. In the Project Name field, enter a suitable name for your project. (CoolDoc would be a fine name, as long as it is unique.)
6. Click on OK. The dialog box disappears and the project is renamed to CoolDoc.

If you expand all the objects under CoolDoc, you should see a module or two in the project. (Remember; VBA macros are contained in modules.) For the sake of this discussion, let's assume that MyMacro (the one you want to run) is contained within the HotStuff module of the CoolDoc project. (All these object names will be used shortly. At this point you just need to note the names used for your project and the module with the macro.)

Now you are ready to actually add the CoolDoc project reference to the project from which the macro will be called. In this instance, let's assume you will be calling it from a macro in the Normal project. You can add the reference by following these steps (assuming that the VBA editor is still open):

1. In the Project window at the upper-left of the VBA editor, select the Normal folder.
2. Choose References from the Tools menu. The References dialog box is displayed. (See Figure 1.)



Figure 1. The References dialog box.

3. In the list of available references, find CoolDoc.
4. Make sure the check box to the left of the CoolDoc option is selected.
5. Click on OK.

Finally you are ready to add the Call statement to the macro from which you want to call MyMacro. The command line would appear as follows:

Call CoolDoc.HotStuff.MyMacro

This command line causes VBA to run the desired macro, without any chance of ambiguity. There is something important to note, however. Putting a reference to the CoolDoc project in Normal makes Normal load a copy of CoolDoc every time Word is started—even if there are no documents open that are based on the CoolDoc.dot template.

This loading of CoolDoc raises and obvious question: What is the point, in VBA, of putting MyMacro in CoolDoc.dot since it won't save load time or resource usage? The short answer is that there isn't any point, other than CoolDoc.dot possibly being a more obvious place to put code that only relates to things in CoolDoc.dot. (This whole topic of sensible project design is far too big a subject to discuss in this single tip.)

WordTips is your source for cost-effective Microsoft Word training. (Microsoft Word is the most popular word processing software in the world.) This tip (86) applies to Microsoft Word 97, 2000, 2002, and 2003. You can find a version of this tip for the ribbon interface of Word (Word 2007 and later) here: Using Call to Run VBA Macros.