C#调用Excel VBA宏[转载]

原文地址：https://www.cnblogs.com/heekui/archive/2008/03/30/1129355.html

近日的一系列工作是做网站的营运维护，因此做了大量的支持工具。有Excel中写VBA的，也有直接C#做的工具。有时需要在C#中执行Excel VBA宏，甚至有时还需要在执行了VBA宏之后，获取返回值再进行相应的处理。为了使用方便，我写了一个执行Excel VBA宏的帮助类 。放在博客里做个备份也希望对有类似需求的朋友有所帮助。

帮助类仅提供了一个方法：RunExcelMacro
参数说明：
        string         excelFilePath  Excel文件路径        
        string         macroName    宏名称
        object[]     parameters     宏参数组
        out object  rtnValue         宏返回值
        bool            isShowExcel   执行时是否显示Excel

补充说明：VBA宏需如下图写在模块中，才能被此方法识别。写在ThisWorkBook中不能被识别。

执行Excel VBA宏帮助类，注释比较详细，不再累赘代码过程。最核心部分其实就是通过反射方式调用Excel VBA宏,oBook.Save()这句话也很重要，否则即使执行了VBA宏调用，也不会保存Excel更改后的内容：

    /// <summary>
    /// 执行Excel VBA宏帮助类
    /// </summary>
    public class ExcelMacroHelper
    {
        /// <summary>
        /// 执行Excel中的宏
        /// </summary>
        /// <param name="excelFilePath">Excel文件路径</param>
        /// <param name="macroName">宏名称</param>
        /// <param name="parameters">宏参数组</param>
        /// <param name="rtnValue">宏返回值</param>
        /// <param name="isShowExcel">执行时是否显示Excel</param>
        public void RunExcelMacro(
                                            string excelFilePath,
                                            string macroName,
                                            object[] parameters,
                                            out object rtnValue,
                                            bool isShowExcel
                                        )
        {
            #region 检查入参
            // 检查文件是否存在
            if (!File.Exists(excelFilePath))
            {
                throw new System.Exception(excelFilePath + " 文件不存在");
            }

            // 检查是否输入宏名称
            if (string.IsNullOrEmpty(macroName))
            {
                throw new System.Exception("请输入宏的名称");
            }
            #endregion


            #region 宏参数对象
            // 准备打开Excel文件时的缺省参数对象
            object oMissing = System.Reflection.Missing.Value;

            // 根据参数组是否为空，准备参数组对象
            object[] paraObjects;

            if (parameters == null)
            {
                paraObjects = new object[] { macroName };
            }
            else
            {
                // 宏参数组长度
                int paraLength = parameters.Length;

                paraObjects = new object[paraLength + 1];

                paraObjects[0] = macroName;
                for (int i = 0; i < paraLength; i++)
                {
                    paraObjects[i + 1] = parameters[i];
                }
            }
            #endregion

            // 创建Excel对象示例
            Microsoft.Office.Interop.Excel.Application oExcel = new Microsoft.Office.Interop.Excel.Application();

            try
            {                
                // 判断是否要求执行时Excel可见
                if (isShowExcel)
                {
                    // 使创建的对象可见
                    oExcel.Visible = true;
                }

                // 创建Workbooks对象
                Microsoft.Office.Interop.Excel.Workbooks oBooks = oExcel.Workbooks;
                // 创建Workbook对象
                Microsoft.Office.Interop.Excel._Workbook oBook = null;
                // 打开指定的Excel文件
                oBook = oBooks.Open(
                                        excelFilePath,
                                        oMissing,
                                        oMissing,
                                        oMissing,
                                        oMissing,
                                        oMissing,
                                        oMissing,
                                        oMissing,
                                        oMissing,
                                        oMissing,
                                        oMissing,
                                        oMissing,
                                        oMissing,
                                        oMissing,
                                        oMissing
                                   );

                // 执行Excel中的宏
                rtnValue = this.RunMacro(oExcel, paraObjects);

                // 保存更改
                oBook.Save();

                // 退出Workbook
                oBook.Close(false, oMissing, oMissing);


                #region 释放对象

                // 释放Workbook对象
                System.Runtime.InteropServices.Marshal.ReleaseComObject(oBook);
                oBook = null;

                // 释放Workbooks对象
                System.Runtime.InteropServices.Marshal.ReleaseComObject(oBooks);
                oBooks = null;

                #endregion
            }
            catch (Exception ex)
            {
                throw ex;
            }
            finally
            {
                if(oExcel != null)
                {

                    // 关闭Excel
                    oExcel.Quit();

                    // 释放Excel对象
                    System.Runtime.InteropServices.Marshal.ReleaseComObject(oExcel);
                    oExcel = null;

                    // 调用垃圾回收
                    GC.Collect();
                }
            }
        }

        /// <summary>
        /// 执行宏
        /// </summary>
        /// <param name="oApp">Excel对象</param>
        /// <param name="oRunArgs">参数（第一个参数为指定宏名称，后面为指定宏的参数值）</param>
        /// <returns>宏返回值</returns>
        private object RunMacro(object oApp, object[] oRunArgs)
        {
            try
            {
                // 声明一个返回对象
                object objRtn;

                // 反射方式执行宏
                objRtn = oApp.GetType().InvokeMember(
                                                        "Run",
                                                        System.Reflection.BindingFlags.Default |
                                                        System.Reflection.BindingFlags.InvokeMethod,
                                                        null,
                                                        oApp,
                                                        oRunArgs
                                                     );

                // 返回值
                return objRtn;

            }
            catch (Exception ex)
            {
                // 如果有底层异常，抛出底层异常
                if (ex.InnerException.Message.ToString().Length > 0)
                {
                    throw ex.InnerException;
                }
                else
                {
                    throw ex;
                }
            }
        }
    }

 

示例三个VBA宏方法：

 Sub getTime()
 
     Sheet1.Cells(1, 1) = Now
 
 End Sub
 
 
 Sub getTime2(title As String)
 
     Sheet1.Cells(2, 1) = title & " : " & Now
 
 End Sub
 
 Function getTime3(title As String)  As String
 
     getTime3 = title & " : " & Now
 
 End Function

对应的三个使用方法
1 不带参数的宏调用（兼演示执行过程显示Excel文件）
2 带参数的宏调用（兼演示执行过程不显示Excel文件）
3 有返回值的宏调用

 

private void btnExe_Click(object sender, EventArgs e)
{
    try
    {
        // 返回对象
        object objRtn = new object();

        // 获得一个ExcelMacroHelper对象
        ExcelMacroHelper excelMacroHelper = new ExcelMacroHelper();

        // 执行指定Excel中的宏，执行时显示Excel
        excelMacroHelper.RunExcelMacro(
                                            @"E:\csharp_study\DoVBAMacro\test.xls",
                                            "getTime2",
                                            new Object[] { "现在时刻" },
                                            out objRtn,
                                            true
                                      );

        // 执行指定Excel中的宏，执行时不显示Excel
        excelMacroHelper.RunExcelMacro(
                                            @"E:\csharp_study\DoVBAMacro\test.xls",
                                            "getTime2",
                                            new Object[] { "现在时刻" },
                                            out objRtn,
                                            false
                                       );

        // 执行指定Excel中的宏，执行时显示Excel，有返回值
        excelMacroHelper.RunExcelMacro(
                                            @"E:\csharp_study\DoVBAMacro\test.xls",
                                            "getTime3",
                                            new Object[] { "现在时刻" },
                                            out objRtn,
                                            true
                                       );

        MessageBox.Show((string)objRtn);

    }
    catch (System.Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

另附一个将Excel里的公式转换成数值的宏代码

 Sub yy()
 Dim Sht As Worksheet
 For Each Sht In Sheets
     Sht.UsedRange = Sht.UsedRange.Value
 Next
 End Sub

 

帮助类需添加引用：Microsoft Excel 11.0 Object Library

示例工程下载

 

转载于:https://www.cnblogs.com/xbzhu/p/8431117.html