VSTO Excel外接程序捕获Ribbon按钮点击后无法触发原默认功能

无法在用户点击Ribbon标准按钮操作、与Excel执行按钮原生处理逻辑之间插入自定义钩子逻辑。

开发一款Excel外接程序，实现捕获Ribbon选项卡上各类标准命令栏按钮的点击事件，自定义逻辑执行完成后，可正常继续执行按钮对应的原默认处理流程。

以捕获「保存」按钮点击事件为例，点击按钮后需同时满足两个要求：

• a) 执行自定义处理逻辑：例如弹出消息提示框、将点击事件记录到纯文本日志文件；
• b) 正常触发Excel原生的工作表保存操作。

参考微软官方两篇技术文档：

1. Temporarily Repurpose Commands on the Office Fluent Ribbon
2. Customizing the 2007 Office Fluent Ribbon for Developers
   目前已实现标准按钮点击事件的捕获，但无法同时达成上述a、b两项要求。

Ribbon1.xml #

<?xml version="1.0" encoding="UTF-8"?>
<customUI xmlns="http://schemas.microsoft.com/office/2009/07/customui" onLoad="Ribbon_Load">
  <commands>
      <command idMso="FileSave" onAction="OnRibbonButtonClick" />
  </commands>
</customUI>

Ribbon1.cs #

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Text;
using System.Windows.Forms;
using Office = Microsoft.Office.Core;

namespace ExcelAddIn
{
    [ComVisible(true)]
    public class Ribbon1 : Office.IRibbonExtensibility
    {
        private Office.IRibbonUI ribbon;

        public Ribbon1()
        {
        }

        #region IRibbonExtensibility Members

        public string GetCustomUI(string ribbonID)
        {
            return GetResourceText("ExcelAddIn.Ribbon1.xml");
        }

        #endregion

        #region Ribbon Callbacks
        // 在此处创建Ribbon回调方法

        public void Ribbon_Load(Office.IRibbonUI ribbonUI)
        {
            this.ribbon = ribbonUI;
        }

        public void OnRibbonButtonClick(Office.IRibbonControl control, bool Cancel)
        //public void OnRibbonButtonClick(Office.IRibbonControl control)
        {
            Globals.ThisAddIn.OnStandardRibbonCommand(control.Id);
            ribbon.Invalidate();
            Cancel = false;
        }           
        #endregion


        #region Helpers

        private static string GetResourceText(string resourceName)
        {
            Assembly asm = Assembly.GetExecutingAssembly();
            string[] resourceNames = asm.GetManifestResourceNames();
            for (int i = 0; i < resourceNames.Length; ++i)
            {
                if (string.Compare(resourceName, resourceNames[i], StringComparison.OrdinalIgnoreCase) == 0)
                {
                    using (StreamReader resourceReader = new StreamReader(asm.GetManifestResourceStream(resourceNames[i])))
                    {
                        if (resourceReader != null)
                        {
                            return resourceReader.ReadToEnd();
                        }
                    }
                }
            }
            return null;
        }

        #endregion
    }
}

使用上述代码可以成功捕获FileSave事件，但文件不会执行保存操作，即Excel默认的保存功能未触发。

1. 是现有代码存在配置遗漏，还是该技术方案本身无法实现「自定义逻辑+原生逻辑同时执行」的需求？
2. 文档中提到的「Temporarily Repurpose Commands on the Office Fluent Ribbon」是否意味着命令会被完全重定义，原有功能无法继续执行？

• Microsoft® Excel® for Microsoft 365 MSO (Version 2205 Build 16.0.15225.20172) 64-bit
• Microsoft Visual Studio Enterprise 2019 Version 16.11.7
• VSTO version 10.0.60724

这个问题不是Office版本或者VSTO框架的bug，是对Ribbon命令重定向机制的理解有偏差，同时代码有两处明显错误：

1. 机制本身的特性：用<command idMso="xxx" onAction="xxx"/>重写内置命令的方式，本质是完全接管按钮的执行权，原生逻辑默认不会自动执行，不存在什么配置开关能让它自动跑原生逻辑。文档里说的「重定义命令」就是这个意思，不是临时插个钩子，是把原有执行链路替换成你的回调。
2. 回调签名错误：你现在写的bool Cancel参数是值类型，方法内赋值不会回传给Office框架，正确的签名里这个参数必须加ref修饰符，框架才能读到你设置的取消状态。
3. 没有手动调用原生功能：重定向命令后，执行权完全在你手里，要触发原生逻辑，必须自己在自定义逻辑跑完之后，调用Excel对象模型对应的API，没有别的捷径。你现在写的ribbon.Invalidate()是强制刷新Ribbon控件状态用的，和执行原命令没有任何关系，平白增加性能开销，没必要加。

修正后的代码 #

首先修改回调方法签名，然后在自定义逻辑执行完成后手动调用保存API即可，以FileSave按钮为例：

public void OnRibbonButtonClick(Office.IRibbonControl control, ref bool CancelDefault)
{
    // 先执行自定义逻辑
    Globals.ThisAddIn.OnStandardRibbonCommand(control.Id);
    
    // 手动调用原生保存逻辑，和点击原生按钮行为完全一致
    try
    {
        var excelApp = Globals.ThisAddIn.Application;
        if (excelApp.Workbooks.Count > 0) // 避免无打开工作簿时空引用报错
        {
            excelApp.ActiveWorkbook.Save();
        }
    }
    catch (Exception ex)
    {
        // 按需加异常处理，比如文件只读、权限不足、被占用时的提示
        MessageBox.Show($"执行保存操作失败：{ex.Message}");
    }

    // 设为false，允许其他加载项注册的同命令回调继续执行
    CancelDefault = false;
}

其他内置按钮的处理逻辑完全一致，自定义逻辑跑完后手动调用对应API就行：

• 另存为按钮（idMso=FileSaveAs）：调用ActiveWorkbook.SaveAs()
• 新建工作簿按钮（idMso=FileNew）：调用Workbooks.Add()
• 打开文件按钮（idMso=FileOpen）：调用excelApp.Dialogs[Office.XlBuiltInDialog.xlDialogOpen].Show()

补充说明 #

CancelDefault参数只有设置为true时才有用，代表完全终止该命令的后续执行链路，设置为false不会自动触发原生逻辑，这点不要搞反。

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