XL98: How to Programmatically Create a Reference (184579)

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 Reference to Another Project

1. Close all open workbooks, and then create two new workbooks.
2. Save the workbooks as Book1 and Book2 in your <hard disk>:Microsoft Office 98 folder, where <hard disk> is the name of your hard disk.
3. Start the Visual Basic Editor (press OPTION+F11).
4. If the Project window is not visible, click Project Explorer on the View menu.
5. In the Project window, click "VBAProject (Book1)."
6. On the Insert menu, click Module.
   
   This step adds a module in the Book1 project.
7. In the module, type the following code, where <hard disk> is the name of your hard disk:

          Sub Create_Reference()
   
              Application.VBE.ActiveVBProject.References.AddFromFile _
                  "<hard disk>:Microsoft Office 98:Book2"
   
              Use_Book2_Reference
   
          End Sub
   
          Sub Use_Book2_Reference()
   
              'Make calls to Book2 objects here.
   
          End Sub
   						

   NOTE: You cannot make reference calls to objects that have been added to the object library programmatically in the same procedure. You must run another procedure to make the calls.
8. In the Project window, click "VBAProject (Book2)."
9. If the Properties window is not visible, click Properties Window on the View menu.
10. Next to the "(Name)" property, type Project2.
    
    NOTE: If you want to create a reference to another project, that project cannot use the same value for the "(Name)" property.
    
    For additional information, please see the following articles in the Microsoft Knowledge Base:

    183132 XL98 Err Msg: "Name Conflicts with Existing Module"

11. Run the Create_Reference macro you created in step 7.
    
    This step creates a reference in Book1 to the project in Book2.
12. To verify the reference, click References on the Tools menu.
    
    In the "References - VBAProject" dialog box, the "Project2" check box should be selected.
13. Click OK.

Removing a Reference to Another Project

The following steps assume you followed all the steps in the "Creating a Reference to Another Project" section.

1. In the module sheet in which you typed the Create_Reference macro, type the following code:

         Sub Remove_Reference()
   
             Dim x As Object
             Set x = Application.VBE.ActiveVBProject _
                .References.Item("Project2")
   
             Application.VBE.ActiveVBProject.References.Remove x
   
         End Sub
   						

2. Run the Remove_Reference macro.
   
   This step removes the reference to the project in Book2.
3. To verify whether Microsoft Excel removed the reference, click References on the Tools menu.
   
   In the "References - VBAProject" dialog box, the "Project2" check box should be cleared.
4. Click OK.