如何检查Excel工作表中是否包含指定宏（C# Excel Interop场景）

当然可以！要避免程序因用户输入的宏不存在而崩溃，我们可以借助Excel Interop的VBA项目对象模型，提前检查目标宏是否存在于当前活动工作表的代码模块中。下面是具体的实现步骤和代码：

核心思路 #

Excel的每个工作表都对应一个VBA代码模块，我们可以通过VBProject和CodeModule对象遍历该模块中的所有过程（也就是宏），对比用户输入的宏名称是否存在。

实现步骤 #

1. 添加必要的引用 #

首先，你的项目需要引用两个Interop库：

• Microsoft.Office.Interop.Excel（用于操作Excel本身）
• Microsoft.Vbe.Interop（用于操作VBA项目模型，可通过NuGet安装，或在COM引用中选择「Microsoft Visual Basic for Applications Extensibility 5.3」）

2. 编写宏检查的辅助方法 #

这个方法会遍历活动工作表的代码模块，检查指定名称的宏是否存在：

using Microsoft.Office.Interop.Excel;
using Microsoft.Vbe.Interop;
using System;
using System.Windows.Forms; // WinForms项目用于弹窗提示，WPF项目可替换为MessageBox.Show的对应实现

public static bool IsMacroExistInActiveWorksheet(Application xlApp, string macroName)
{
    // 先校验基础对象是否有效
    if (xlApp?.ActiveWorkbook == null || xlApp.ActiveSheet == null)
        return false;

    Worksheet activeSheet = xlApp.ActiveSheet;
    // 获取活动工作表对应的VBA代码模块
    VBComponent sheetModule = activeSheet.VBProject.VBComponents[activeSheet.CodeName];
    CodeModule codeModule = sheetModule.CodeModule;

    int totalLines = codeModule.CountOfLines;
    if (totalLines == 0) // 模块为空，肯定没有宏
        return false;

    int currentLine = 1;
    // 遍历模块中的所有过程
    while (currentLine <= totalLines)
    {
        // 获取当前行所属的过程名称和类型
        string procName = codeModule.ProcOfLine(currentLine, out vbext_ProcKind procKind);
        // 只检查标准过程（排除函数、属性等），并对比名称
        if (procKind == vbext_ProcKind.vbext_pk_Proc 
            && procName.Equals(macroName, StringComparison.OrdinalIgnoreCase))
        {
            return true;
        }
        // 跳到下一个过程的起始行，避免重复遍历
        currentLine = codeModule.ProcStartLine[procName, procKind] + codeModule.ProcCountLines[procName, procKind] + 1;
    }

    return false;
}

3. 修改原有代码，加入检查逻辑 #

在打开工作表后、运行宏之前，调用上面的辅助方法，根据结果执行不同操作：

string excelFilePath = "你的Excel文件路径";
string userInputMacroName = "用户输入的宏名称";

Application xlApp = new Application();
try
{
    // 打开Excel工作簿
    Workbook workbook = xlApp.Workbooks.Open(Path.GetFullPath(excelFilePath).Replace("\"", ""));
    
    // 检查宏是否存在
    if (IsMacroExistInActiveWorksheet(xlApp, userInputMacroName))
    {
        xlApp.Run(userInputMacroName);
        MessageBox.Show("宏执行成功！");
    }
    else
    {
        MessageBox.Show($"活动工作表中不存在名为「{userInputMacroName}」的宏，请检查输入！");
    }
}
catch (Exception ex)
{
    MessageBox.Show($"操作出错：{ex.Message}");
}
finally
{
    // 务必清理Excel资源，避免后台残留进程
    if (xlApp?.ActiveWorkbook != null)
        xlApp.ActiveWorkbook.Close(SaveChanges: false);
    xlApp?.Quit();
    System.Runtime.InteropServices.Marshal.ReleaseComObject(xlApp);
}

重要注意事项 #

• Excel权限设置：默认情况下，Excel会禁止程序访问VBA项目对象模型，需要用户手动开启：打开Excel → 文件 → 选项 → 信任中心 → 信任中心设置 → 宏设置 → 勾选「信任对VBA项目对象模型的访问」。否则代码会抛出权限异常。
• 宏的位置：上面的代码只检查活动工作表的代码模块中的宏，如果你的宏可能在标准模块（比如Module1）中，可以修改逻辑，遍历activeSheet.VBProject.VBComponents下的所有模块，而不仅仅是活动工作表的模块。
• 大小写匹配：代码中用了OrdinalIgnoreCase忽略大小写，如果需要严格匹配，可以移除这个参数。

内容的提问来源于stack exchange，提问作者Yoboi