Knowledge Base

Running Visual Basic for Applications Procedures from AppleScript

Article ID: 175425

Article Last Modified on 10/10/2006

APPLIES TO

Microsoft Excel 5.0a for Macintosh

This article was previously published under Q175425

SUMMARY

AppleScript is a scripting language you can use to automate processes on a Macintosh computer. The commands and syntax used in AppleScript are much like a programming language and have the ability to control applications outside the Finder.

This article provides sample AppleScript scripts that demonstrate how to call Microsoft Visual Basic for Applications Sub procedures (including macros) and Function procedures.

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. AppleScript is manufactured by Apple Computer Inc., a vendor independent of Microsoft; we make no warranty, implied or otherwise, regarding this product's performance or reliability.

To call a Visual Basic procedure from an AppleScript script, you can use Evaluate or Do Script, followed by the appropriate syntax for specifying the name of the procedure (and possible arguments). Because there is not a discernible difference between Evaluate and Do Script, Evaluate is used in all sample scripts in this article.

NOTE: All examples provided in this article assume Microsoft Excel is running and the sample procedure being called is contained in an open workbook called "Workbook1."

Recording a Script That Launches a Microsoft Excel Macro

Creating the Macro:

Start Microsoft Excel.
On the Insert menu, point to Macro, and then click Module.

Type the following in the module:

      Sub Test_Recording()
         MsgBox "This is a Excel macro."
      End Sub

Activate Sheet1.
On the File menu, click Save.
Save the workbook as Workbook1.
Leave Excel open.

Recording the Script:

Start AppleScript Editor.
If you do not have an untitled script window open, click New Script on the File menu.
Click Record.
On the Application menu, click Microsoft Excel.
On the Tools menu, click Macro.
In the list of macros, click Test_Recording, and then click Run.

A message box appears displaying the message "This is a Microsoft Excel macro."
Click OK.
On the Application menu, click Script Editor.
Click Stop.

The recorded script looks like the following:
```
       tell application "Microsoft Excel"
          Activate
          Evaluate "Workbook1!Test_Recording()"
       end tell
                        
```
NOTE: To start Visual Basic procedures (including macros) from an AppleScript script, you must follow the name of the procedure with parentheses.
On the File menu, click Save.
Select a destination folder, type a name for your script in the Save Script As box, and then click Save.

Playing Back the Recorded Script:

With the recorded script displayed in the Script Editor window, click Run.

The Test_Recording macro runs, and the message box appears displaying the message "This is a Microsoft Excel macro."

Click OK.
On the Application menu, click Script Editor.

Passing Arguments to a Visual Basic Procedure

In the preceding example, you created a script that calls a Visual Basic macro. A Visual Basic macro is a public Sub procedure that does not accept any arguments. However, you can pass arguments to Sub and Function procedures.

As mentioned earlier in this article, you must follow the name of the procedure with parentheses if you want to start it from an AppleScript script. If you are passing arguments to a procedure, you place them between the parentheses.

Passing a Single Value to a Sub Procedure:

Open the workbook (Workbook1) that you created earlier in this article, and then activate Module1.

Type the following code in the module:

      Sub Pass_1_Argument(x)

         Worksheets("Sheet1").Cells(1,1).Value = x

      End Sub

Activate Sheet1.
On the File menu, click Save.
Leave Microsoft Excel open. Start Script Editor and type the following in a new script window:
```
      tell application "Microsoft Excel"
         set myvalue to 10
         Activate
         Evaluate "Workbook1!Pass_1_Argument(" & myvalue & ")"
      end tell
                        
```
NOTE: In order to pass a variable to a Visual Basic procedure, you must concatenate the variable into the Evaluate or Do Script statement. If you want to pass a constant value to the procedure, you can place the value between the parentheses without using concatenation. If you want to pass a constant value, the Evaluate line becomes the following:
```
      Evaluate "Workbook1!Pass_1_Argument(10)
                        
```
On the File menu, click Save.
Select a destination folder, type a name for your script in the Save Script As box, and then click Save.
Run the script.

The script activates Microsoft Excel and places the value 10 in cell A1 on Sheet1.

Returning a Value from a Procedure to a Script

If you want to return a value from a Visual Basic Sub procedure, you will be limited to a True Boolean value when the subroutine completes successfully. However, if you are calling a function, you can return any numerical, Boolean, or string value back to the AppleScript script. Whether you are calling a Microsoft Excel Sub or Function procedure, the value is returned to a predefined AppleScript variable named "result."

Returning a Value from a Function:

Activate Microsoft Excel, and open the workbook (Workbook1) that you created earlier in this article.

Activate Module1 and type the following code:

      Function Return_Function_Value(x) As Integer

         Return_Function_Value = x * 2

      End Function

Leave Microsoft Excel open. Start Script Editor and type the following in a new script window:

      tell application "Microsoft Excel"
         Evaluate "Workbook1!Return_Function_Value(10)
         set myvalue to result + 1
         display dialog myvalue
      end tell

On the File menu, click Save.
Select a destination folder, type a name for your script in the Save Script As box, and then click Save.
Run the script.

An AppleScript dialog box appears displaying the value 21.
Click OK.

Returning a Value from a Sub Procedure:

Activate Microsoft Excel, and open the workbook (Workbook1) that you created earlier in this article.

Activate Module1, and type the following code:

      Sub Return_Sub_Value()

         Sheets("Sheet1").Cells(1, 1).Value = 1

      End Sub

Leave Microsoft Excel open. Start Script Editor, and type the following in a new script window:

      tell application "Microsoft Excel"
         Evaluate "Workbook1!Return_Sub_Value()"
         if result then
            display dialog "Success"
         end if
      end tell

On the File menu, click Save.
Select a destination folder, type a name for your script in the Save Script As box, and then click Save.
Run the script.

An AppleScript dialog box appears displaying "success".
Click OK.

Error Trapping Values Returned from a Procedure

There are situations in which your Sub or Function procedure fails due to user-intervention or a run-time error. This section discusses ways to communicate back to your AppleScript script that an error occurred in the Visual Basic procedure.

Error Trapping for a Sub Procedure:

Because a Sub procedure cannot explicitly pass a value back to its AppleScript caller, you can work around it by having the procedure store a value in a worksheet cell or a defined name in the workbook. Then, your script can check the current value of the cell or defined name to see if an error occurred. The following example uses a defined name to hold the status of any error in the Sub procedure.

Activate Microsoft Excel, and open the workbook (Workbook1) that you created earlier in this article.
On the Insert menu, point to Name, and then click Define.
Type myerr in the Names in Workbook box.
Delete any text in the Refers To box, and then type = "ok" in the Refers To box. Click OK.

Activate Module1, and type the following code:

       Sub Return_Sub_Error()

          ThisWorkbook.Names("myerr").RefersTo = "ok"

          On Error GoTo handle:

          x = MsgBox(Prompt:="Click Yes for an error, otherwise click No" _
             , Buttons:=vbYesNo)
          If x = vbYes Then
             Error 1004      ' Generates a run-time error.
          End If

          Exit Sub

          handle:
          ThisWorkbook.Names("myerr").RefersTo = Err

       End Sub

Leave Microsoft Excel open. Start Script Editor, and type the following in a new script window:

       tell application "Microsoft Excel"
          Activate
          Evaluate "Workbook1!Return_Sub_Error()"
          if not(Evaluate "Workbook1!myerr") = "ok" then
             set myerr to Evaluate ("Workbook1!myerr")
             set myerr to myerr as integer
             display dialog "An error occurred in the macro: " & myerr
          else
             display dialog "No error."
          end if
       end tell

On the File menu, click Save.
Select a destination folder, type a name for your script in the Save Script As box, and then click Save.
Run the script.

The script activates Microsoft Excel and displays a message box.
Click Yes.

This creates an error condition in the Sub procedure and changes the value of the defined name "myerr." Then, an AppleScript dialog box appears displaying the message "An error occurred in the macro: 1004."
Click OK.

NOTE: If you click No in Step 10, the script displays a dialog box with the message "No error."

Error Trapping for a Function:

Since a function can return a value to its caller, passing this information back to a script is much easier than it is for a Sub procedure.

Activate Microsoft Excel, and open the workbook (Workbook1) that you created earlier in this article.

Activate Module1, and type the following code:

      Function Return_Function_Error () As Integer

         On Error GoTo handle:

         x = MsgBox(Prompt:="Click Yes for an error, otherwise click No" _
             , Buttons:=vbYesNo)
         If x = vbYes Then
            Error 1004      ' Generates a run-time error.
         Else
            Return_Function_Error = 0
         End If

         Exit Function

         handle:
            Return_Function_Error = Err

      End Function

Leave Microsoft Excel open. Start Script Editor, and type the following in a new script window:

      tell application "Microsoft Excel"
         Activate
         Evaluate "Workbook1!Return_Function_Error()"
         if not (result = 0) then
            set myerr to result as integer
            display dialog "An error occurred in the macro: " & myerr
         else
            display dialog "No error"
         end if

      end tell

On the File menu, click Save.
Select a destination folder, type a name for your script in the Save Script As box, and then click Save.
Run the script.

The script activates Microsoft Excel and displays a message box.
Click Yes.

This creates an error condition in the function, and the function value will be set to the value of the error. Then, an AppleScript dialog box displays the message "An error occurred in the macro: 1004."
Click OK.

NOTE: If you click No in step 7, the script displays a dialog box with the message "No error."

Additional query words: mac vbe vba MXL5

Keywords: kbcode kbhowto kbprogramming KB175425

Microsoft KB Archive/175425

Contents

Running Visual Basic for Applications Procedures from AppleScript

SUMMARY

MORE INFORMATION

Recording a Script That Launches a Microsoft Excel Macro

Passing Arguments to a Visual Basic Procedure

Returning a Value from a Procedure to a Script

Error Trapping Values Returned from a Procedure