Excel自定义RibbonUI+COM可见DLL：如何在DLL中订阅Ribbon控件事件？

现有C# COM可见DLL已能处理Excel工作簿及ActiveX控件事件，但无法将CustomRibbonUI中的按钮点击事件迁移到DLL中实现。以下是实现方案，仅保留VBA中的RibbonOnLoad及代理方法，核心逻辑全部放在C# DLL中。

一、C#端实现Ribbon事件处理 #

1. 定义COM可见的Ribbon处理接口 #

创建接口用于接收Ribbon实例并声明按钮事件处理方法：

using System;
using System.Runtime.InteropServices;
using Microsoft.Office.Core;

namespace ProjectXLib.Source
{
    [ComVisible(true)]
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    [Guid("A1B2C3D4-5678-90EF-GHIJ-KLMNOPQRSTUV")] // 替换为新生成的GUID
    public interface IRibbonHandler
    {
        void AttachRibbon(IRibbonUI ribbon);
        void OnBtnResetClicked(IRibbonControl control);
        void OnBtnFindInvalidCellsClicked(IRibbonControl control);
    }
}

2. 实现RibbonHandler类 #

实现接口，编写按钮点击的具体逻辑，同时保留工作簿和Ribbon实例：

using System;
using System.Runtime.InteropServices;
using Microsoft.Office.Core;
using Excel = Microsoft.Office.Interop.Excel;

namespace ProjectXLib.Source
{
    [ComVisible(true)]
    [ClassInterface(ClassInterfaceType.None)]
    [Guid("VUTSRQPONML-KJIH-FE09-8765-4D3C2B1A")] // 替换为新生成的GUID
    [ProgId(nameof(RibbonHandler))]
    public class RibbonHandler : IRibbonHandler
    {
        private IRibbonUI _ribbonUI;
        private Excel.Workbook _workbook;

        // 初始化工作簿实例，方便后续操作Excel对象
        public void Initialize(Excel.Workbook workbook)
        {
            _workbook = workbook;
        }

        // 接收Ribbon实例，可用于后续刷新Ribbon
        public void AttachRibbon(IRibbonUI ribbon)
        {
            _ribbonUI = ribbon;
        }

        // Reset按钮点击逻辑
        public void OnBtnResetClicked(IRibbonControl control)
        {
            _workbook.ActiveSheet.Cells.ClearContents();
            // 可添加更多自定义逻辑
        }

        // 查找无效单元格按钮点击逻辑
        public void OnBtnFindInvalidCellsClicked(IRibbonControl control)
        {
            _workbook.ActiveSheet.CircleInvalid();
            // 可添加更多自定义逻辑
        }
    }
}

二、VBA端配置及代理实现 #

1. 修改CustomRibbonUI XML #

更新Ribbon配置，指定onLoad事件和按钮的onAction代理方法：

<customUI xmlns="http://schemas.microsoft.com/office/2009/07/customui" onLoad="RibbonOnLoad">
  <ribbon startFromScratch="false">
    <tabs>
      <tab id="idMacros" label="Macros">
        <group id="idErrors" label="Errors">
          <button id="btnReset" label="Reset" imageMso="HappyFace" size="large" onAction="OnBtnReset"/>
          <button id="btnFindInvalidCells" label="Invalid cells" imageMso="HappyFace" size="large" onAction="OnBtnFindInvalidCells"/>
        </group>
      </tab>
    </tabs>
  </ribbon>
</customUI>

2. VBA代码实现 #

保留RibbonOnLoad方法创建DLL实例，并添加代理方法转发事件到DLL：

Option Explicit
Private ribbonHandler As ProjectXLib.RibbonHandler
Private myRibbon As IRibbonUI

' Ribbon加载时初始化DLL实例
Sub RibbonOnLoad(ribbon As IRibbonUI)
    Set myRibbon = ribbon
    Set ribbonHandler = New ProjectXLib.RibbonHandler
    ' 传递当前工作簿给DLL
    ribbonHandler.Initialize Excel.ThisWorkbook
    ' 传递Ribbon实例给DLL（可选，用于刷新Ribbon）
    ribbonHandler.AttachRibbon myRibbon
End Sub

' 代理Reset按钮点击事件到DLL
Sub OnBtnReset(control As IRibbonControl)
    ribbonHandler.OnBtnResetClicked control
End Sub

' 代理查找无效单元格按钮点击事件到DLL
Sub OnBtnFindInvalidCells(control As IRibbonControl)
    ribbonHandler.OnBtnFindInvalidCellsClicked control
End Sub

三、部署与注意事项 #

1. 生成GUID：使用Visual Studio的「工具->创建GUID」功能为接口和类生成唯一GUID，替换示例中的占位符。
2. 注册DLL：使用Regasm注册DLL，命令示例：regasm /codebase ProjectXLib.dll（/codebase用于非GAC部署）。
3. VBA引用：在Excel VBA项目中，通过「工具->引用」勾选你的COM DLL。
4. 方法签名匹配：Ribbon事件处理方法必须包含IRibbonControl参数，否则事件无法触发。

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