通过 Workbook_Open 事件更改 VSTO 选项卡的可见属性答案

【问题标题】：Changing the VSTO tab's visible property through the Workbook_Open event通过 Workbook_Open 事件更改 VSTO 选项卡的可见属性
【发布时间】：2018-11-30 18:23:45
【问题描述】：

我已经为 Excel VSTO 项目编写了 Ribbon.xml 文件。选项卡元素如下所示：

<tab id="myId" idMso="TabAddIns" label="My Tab" visible="false">

当打开工作簿时，我希望默认情况下隐藏选项卡，这是通过将 visible 属性设置为 false 来实现的。接下来，我想在 Workbook_Open 事件中将 visible 属性更改为 true。这就是我卡住的地方。我认为这并不难，但我花了几个小时在谷歌上搜索答案。似乎大多数示例1）通过button callback切换选项卡的可见性，这不是我想要做的，或者2）能够访问ribbon's properties，到目前为止我还无法复制（尽管，这些资源大部分都是旧的，所以我认为 MS 从那时起移动了这些属性）。

有谁知道如何轻松地将 visible 属性更改为 true 以便显示选项卡？

谢谢！

更新了更多信息：

ThisAddIn.cs

namespace Doodles_Reporting
{
    public partial class ThisAddIn
    {
        public RibbonApi ribbonApi;


        private void ThisAddIn_Startup(object sender, System.EventArgs e)
        {
        }

        private void ThisAddIn_Shutdown(object sender, System.EventArgs e)
        {
        }

        protected override Microsoft.Office.Core.IRibbonExtensibility CreateRibbonExtensibilityObject()
        {
            return new Ribbon();
        }

        void Application_WorkbookOpen(Excel.Workbook Wb)
        {

            //first, check if there is an application/process for each workbook
            Excel.Workbooks books = Globals.ThisAddIn.Application.Workbooks;
            if (books.Count > 1)
            {
                try
                {
                    //close workbook that was just opened and then reopen it with new process/application.
                    string filePath = Wb.FullName;
                    Wb.Close();
                    Excel.Application excelApp = new Excel.Application();
                    excelApp.Visible = true;
                    excelApp.DisplayFullScreen = true;
                    excelApp.Workbooks.Open(filePath);
                }
                catch (Exception ex)
                {
                    MessageBox.Show(ex.Message, "Error", MessageBoxButtons.OK);
                }
            }
            else
            {
                //second, check if the workbook is a Doodles workbook
                try
                {
                    DocumentProperties props = (DocumentProperties)Wb.CustomDocumentProperties;
                    var selectedTable = props["selectedTable"].Value;
                    configureDoodles();
                }
                catch (Exception)
                {
                 //THIS IS WHERE I WANT TO SET THE RIBBON VISIBILITY TO FALSE
                }
            }   
        }

        private void configureDoodles()
        {
            RibbonApi.app = Globals.ThisAddIn.Application;
            RibbonApi.wBookPropertiesConfig = new WorkbookPropertiesConfig(RibbonApi.app.ActiveWorkbook);
            RibbonApi.presenter = new ExcelPresenter(RibbonApi.app.ActiveWorkbook);
            ribbonApi = new RibbonApi();
        }

        #region VSTO generated code

        /// <summary>
        /// Required method for Designer support - do not modify
        /// the contents of this method with the code editor.
        /// </summary>
        private void InternalStartup()
        {
            this.Startup += new System.EventHandler(ThisAddIn_Startup);
            this.Shutdown += new System.EventHandler(ThisAddIn_Shutdown);
            this.Application.WorkbookOpen += new Excel.AppEvents_WorkbookOpenEventHandler(Application_WorkbookOpen);
        }

        #endregion
    }
}

Ribbon.cs

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

        public Ribbon()
        {
        }

        #region IRibbonExtensibility Members

        public string GetCustomUI(string ribbonID)
        {
            return GetResourceText("Doodles_Reporting.Ribbon.xml");
        }

        #endregion

        #region Ribbon Callbacks
        //Create callback methods here. For more information about adding callback methods, visit http://go.microsoft.com/fwlink/?LinkID=271226

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

        public bool toggleVisibility(Office.IRibbonControl control)
        {
            return (control.Id == "TabAddIns") ? true : false;
        }

        public void onSomeEvent()
        {
            this.ribbon.InvalidateControl("TabAddIns");
        }

        public void SignIn(Office.IRibbonControl ribbonUI)
        {
            Globals.ThisAddIn.ribbonApi.signIn();
        }

        public void SqlCreatorFormLoad(Office.IRibbonControl ribbonUI)
        {
            Globals.ThisAddIn.ribbonApi.showSqlCreator();
        }

        public void refreshData(Office.IRibbonControl ribbonUI)
        {
            Globals.ThisAddIn.ribbonApi.refreshData();
        }

        public void drilldownSelectionLoad(Office.IRibbonControl ribbonUI)
        {
            Globals.ThisAddIn.ribbonApi.setDrilldownColumns();
        }

        public void Drilldown(Office.IRibbonControl ribbonUI)
        {
            Globals.ThisAddIn.ribbonApi.drilldown();
        }

        public void editProperties(Office.IRibbonControl ribbonUI)
        {

        }

        #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
    }
}

【问题讨论】：

您尝试了哪些方法，哪些方法不起作用？是您无法从 Workbook_Open 处理程序中获取对选项卡的引用（使用静态字段），还是不起作用？
对，我无法从 Workbook_Open 处理程序中获得对选项卡的引用。请原谅我无知的问题，但是静态字段应该是什么？我也看到了这个链接 (msdn.microsoft.com/en-us/library/bb772088.aspx)，但我无法在 Globals.Ribbons 下找到我的功能区名称。
哪个先触发？ Application_WorkbookOpen 或 CreateRibbonExtensibilityObject?
创建RibbonExtensibilityObject
发布了另一个答案，但我意识到更重要的问题是：哪个先触发 - Application_WorkbookOpen 或 Ribbon_Load？

标签： c# excel vsto

【解决方案1】：

丝带是一只有趣的野兽。它专门设计用于禁止您直接访问其任何元素并禁止您直接操作它们。相反，一切都是通过回调完成的。我对 VSTO 没有太多经验，但我可以解释你在没有 VSTO 的情况下用 C# 或 C++ 会做什么，我相信你可以填补空白。

在您的功能区 XML 中设置 onLoad 回调。首次加载功能区时，Excel 将调用此方法（通过IDispatch）。
```
<customUI ... onLoad="OnRibbonLoaded">
```

实现您的 onLoad 回调，它应该存储提供的 IRibbonUI 引用。

public void OnRibbonLoaded(IRibbonUI ribbon)
{
    this.ribbon = ribbon;
}

对于要动态控制的属性，在功能区 XML 中定义回调。
```
<tab ... getVisible="GetVisible">
```
实现您的可见性回调。如果您的功能区的多个部分使用相同的回调，则传递给此方法的 IRibbonControl 实例可用于确定正在查询哪个选项卡/组/控件。
```
public bool GetVisible(IRibbonControl control)
{
    // here is where you should determine if your tab/group/control should be visible,
    return (some condition) ? true : false;
}
```

当您决定要更新可见性时，请告诉 Excel 使用 IRibbonUI 引用重新查询控件的属性（即调用您的回调）。

void OnSomeEvent()
{
    // you can tell Excel to update the entire ribbon
    this.ribbon.Invalidate();

    // or you can tell Excel to update a single tab/group/control
    this.ribbon.InvalidateControl("my_id");
}

【讨论】：

谢谢，迈克尔！我了解您列出的步骤，但我认为事情变得复杂，因为我本质上希望在 Workbook_Open 事件中调用 GetVisible 方法。 Workbook_Open 事件位于 ThisAddIn 类中，该类由 VSTO 运行时自动实例化。 RibbonUI 由重写方法 CreateRibbonExtensibilityObject 实例化，但此方法不会实例化 ThisAddIn 类中的字段。它似乎在内部某处实例化了一个ribbonUI 变量。所以，我被卡住了，因为我无法从 ThisAddIn 类中引用功能区。

【解决方案2】：

你已经得到了所有的碎片。

在ThisAddin 中，您将覆盖CreateRibbonExtensibilityObject。与其返回new Ribbon，不如返回一个您持有的对象。

public partial class ThisAddIn
{
    private readonly Ribbon _ribbon = new Ribbon();

    protected override Microsoft.Office.Core.IRibbonExtensibility CreateRibbonExtensibilityObject()
    {
        return this._ribbon;
    }
}

然后，向该对象添加一个公共的Invalidate() 方法，或者将该对象的IRibbonUI 字段设为公共并调用Invalidate/InvalidateControl。我可能会做前者。

[ComVisible(true)]
public class Ribbon : Office.IRibbonExtensibility
{
    private Office.IRibbonUI _ribbonUI;

    public void Invalidate()
    {
        this._ribbonUI.Invalidate();
    }

    public void InvalidatePlayButton()
    {
        this._ribbonUI.Invalidate("PlayButton");
    }
}

然后从Application_WorkbookOpen 调用这些公共方法。

public partial class ThisAddIn
{
    void Application_WorkbookOpen(Excel.Workbook Wb)
    {
        this._ribbon.Invalidate();
        this._ribbon.InvalidatePlayButton();
    }
}

请注意，如果您愿意，可以将这些对象组合成一个对象。只需让ThisAddin 实现Microsoft.Office.Core.IRibbonExtensibility 并从CreateRibbonExtensibilityObject 返回this。

但是，创建一个单独的对象有一些好处。例如，将功能区封装在更强大的公共方法和属性中变得很容易。例如：

public class Ribbon : Office.IRibbonExtensibility
{
    private Office.IRibbonUI _ribbonUI;

    private bool _isPlayButtonVisible = true;

    // here's a property that makes it easy to update the visibility of the play button
    public bool IsPlayButtonVisible
    {
        get { return this._isPlayButtonVisible; }
        set
        {
            if (this._isPlayButtonVisible != value)
            {
                this._isPlayButtonVisible = value;
                this._ribbonUI.InvalidateControl("PlayButton");
            }
        }
    }

    // here's the callback that Excel will call
    public bool GetIsPlayButtonVisible(IRibbonControl control)
    {
        return this.IsPlayButtonVisible
    }
}

【讨论】：

谢谢你，Michael，但 Invalidate 并没有隐藏控件，对吧？它只清空控件的缓存。我认为为了使它工作，我仍然需要一个 GetVisible 回调方法来更新 _isPlayButtonVisible 字段。本质上 IsPlayButtonVisible 方法将成为 GetVisible 回调方法，对吗？它所要做的就是 !_isPlayButtonVisible。
是的，您仍然需要回调。不幸的是，您不能将属性用作回调，因此您需要 GetVisible 或 GetPlayButtonVisible 方法。我会更新最后的代码sn-p。

【解决方案3】：

对于任何想知道如何使用设计师的丝带来做到这一点的人：

如果你尝试过：

Globals.Ribbons.MyRibbon.MyRibbonTab.Visible = false;

什么也没发生，尝试将所有 RibbonGroups 设置为 Visible = false。当你的 Ribbon 中的所有 RibbonGroups 都不可见时，整个 Ribbon 会自动设置为 Visible = false。

private void SetRibbonVisibility(bool visible)
    {
        foreach (var ribbonGroup in Globals.Ribbons.Ribbon.MyRibbonTab.Groups)
        {
            ribbonGroup.Visible = visible;
        }
    }

是的，与 VSTO 合作很愉快。

【讨论】：

注意：如果您之前在设计器中将选项卡可见性设置为 false，我似乎不起作用。

【解决方案4】：

所以，我发现使用功能区设计器可以让这一切变得简单得多。在我创建一个新的 Ribbon Designer 类后，该类被添加到 Globals.Ribbons 下的对象模型中。这意味着隐藏选项卡变得像我认为的那样简单，只需一行代码：

Globals.Ribbons.RibbonVisual.Doodles.Visible = false;

RibbonVisual 是我创建的功能区设计器类的名称，Doodles 是选项卡的名称。

从现在开始我将使用功能区设计器，哈哈：P。

【讨论】：