Excel催化剂开源第5波-任务窗格在OFFICE2013中新建文档不能同步显示问题解决

在OFFICE2013及之后，使用了单文档界面技术，不同于以往版本可以共享任务空格、功能区。所以当开发任务窗格时，需要考虑到每一个工作薄都关联一个任务窗格。

背景介绍

单文档界面摘录官方定义如下：
对 Excel 2013 中的单文档界面 (SDI) 进行更改对可编程性具有一定影响。SDI 意味着每个工作簿都将有其自己的顶级应用程序窗口，并将有自己的相应功能区。

带来的好处是不同工作薄可以精细控制不同的显示，例如工作薄A，显示功能区Tab1，工作薄B显示功能区Tab2，区分对待不同文档所使用的功能。

带来的不便之处就是要每个文档都要考虑关联对应的界面，特别是任务窗格。

具体代码实现

Excel催化剂插件也大量使用了任务窗格，为了让用户在作配置信息时，可以更灵活，不必每次都弹出一个窗体来配置，只有需要配置时，才转到任务窗格中配置，否则保留默认的配置，并且默认配置可以让用户在任务窗格上查看。

所以用了任务窗格，需要做版本兼容性，即区分Excel2013及之后的版本的SDI特性。

下面截取关键代码，以Excel工作薄的工作表导航功能为例，作简单解释

 

工作表导航任务窗格

先初始化字典变量

        private static void InialTaskPanel()
        {
            Utilities.TaskPanelUtility.CustomTaskPanesOfWorksheetNavigation = new Dictionary<int, Microsoft.Office.Tools.CustomTaskPane>();
            Utilities.TaskPanelUtility.UscWorksheetNavigations = new Dictionary<int, UscWorksheetNavigation>();
        }

根据不同版本的Excel启用不同方法

        private void tgbShowActionPanel_Click(object sender, RibbonControlEventArgs e)
        {
            RibbonToggleButton tgb = sender as RibbonToggleButton;
            try
            {
                if (Single.Parse(Common.ExcelApp.Version) >= 15)
                {

                    WorksheetNavigate.ShowCustomTaskPanelOfWorksheetNavigationOfExcel2013(tgb.Checked);
                }
                else
                {
                    WorksheetNavigate.ShowCustomTaskPanelOfWorksheetNavigationOfExcel2010(tgb.Checked);
                }
                //将工作表导航的显示状态保存起来
                Properties.Settings.Default.IsPaneVisible = tgb.Checked;
                Properties.Settings.Default.Save();
            }
            catch (Exception ex)
            {
                Common.OutMsgError(ex);
            }
        }

重点是2013版的方法，关键之处是拿到当前的活动窗体的句柄，通过字典查找是否已经创建过，没创建就新建，新建完要把它句柄存入到字典中。

        public static void ShowCustomTaskPanelOfWorksheetNavigationOfExcel2013(bool isPaneVisible)
        {
            int hwndCustomTaskPane = Common.ExcelApp.ActiveWindow.Hwnd;
            Microsoft.Office.Tools.CustomTaskPane activeCustomTaskPane;
          Utilities.TaskPanelUtility.CustomTaskPanesOfWorksheetNavigation.TryGetValue(hwndCustomTaskPane, out activeCustomTaskPane);
            if (activeCustomTaskPane == null)
            {
                UscWorksheetNavigation uscWorksheetNavigation = new UscWorksheetNavigation();
                activeCustomTaskPane = Globals.ThisAddIn.CustomTaskPanes.Add(uscWorksheetNavigation, "工作表导航", Globals.ThisAddIn.Application.ActiveWindow);
                activeCustomTaskPane.DockPosition = Office.MsoCTPDockPosition.msoCTPDockPositionLeft;
                activeCustomTaskPane.Width = 300;

                activeCustomTaskPane.VisibleChanged += ActiveCustomTaskPane_VisibleChanged;
                activeCustomTaskPane.Visible = isPaneVisible;
                Utilities.TaskPanelUtility.CustomTaskPanesOfWorksheetNavigation.Add(hwndCustomTaskPane, activeCustomTaskPane);
                Utilities.TaskPanelUtility.UscWorksheetNavigations.Add(hwndCustomTaskPane, uscWorksheetNavigation);
            }
            else
            {
                activeCustomTaskPane.Visible = isPaneVisible;
                if (isPaneVisible)
                {
                    Utilities.TaskPanelUtility.UscWorksheetNavigations[hwndCustomTaskPane].ReLoadWorksheetName();
                }
            }
        }

因工作表导航，每切换一次工作薄，都要更新下工作表清单，所以订阅了一个窗体切换事件，其他场景可能不必这样做，只需订阅个打开文件事件即可。

        private void ExcelApp_WindowActivate(Excel.Workbook Wb, Excel.Window Wn)
        {
            try
            {
                if (Common.ExcelApp.ActiveWorkbook.ProtectStructure == false)
                {
                    bool isPaneVisible = Properties.Settings.Default.IsPaneVisible;

                    if (Single.Parse(Common.ExcelApp.Version) >= 15)
                    {
                        int hwndCustomTaskPane = this.Application.ActiveWindow.Hwnd;
                        WorksheetNavigate.ShowCustomTaskPanelOfWorksheetNavigationOfExcel2013(isPaneVisible);
                    }
                    else
                    {
                        WorksheetNavigate.ShowCustomTaskPanelOfWorksheetNavigationOfExcel2010(isPaneVisible);
                    }
                }
            }
            catch (Exception)
            {

            }

        }

其他的非关键代码，自己把握如何写就行，笔者写代码也有限，只能抛砖引玉了。

结语

通过直接的源代码讲解，希望对Excel开发的朋友们可以带来一些帮助，具体原理之外的东西，可自由发挥。

技术交流QQ群

QQ群名：Excel催化剂开源讨论群， QQ群号：788145319

 

Excel催化剂开源讨论群二维码

关于Excel催化剂

Excel催化剂先是一微信公众号的名称，后来顺其名称，正式推出了Excel插件，插件将持续性地更新，更新的周期视本人的时间而定争取一周能够上线一个大功能模块。Excel催化剂插件承诺个人用户永久性免费使用！

Excel催化剂插件使用最新的布署技术，实现一次安装，日后所有更新自动更新完成，无需重复关注更新动态，手动下载安装包重新安装，只需一次安装即可随时保持最新版本！

Excel催化剂插件下载链接：https://pan.baidu.com/s/1Iz2_NZJ8v7C9eqhNjdnP3Q

 

联系作者

 

公众号

取名催化剂，因Excel本身的强大，并非所有人能够立马享受到，大部分人还是在被Excel软件所虐的阶段，就是头脑里很清晰想达到的效果，而且高手们也已经实现出来，就是自己怎么弄都弄不出来，或者更糟的是还不知道Excel能够做什么而停留在不断地重复、机械、手工地在做着数据，耗费着无数的青春年华岁月。所以催生了是否可以作为一种媒介，让广大的Excel用户们可以瞬间点燃Excel的爆点，无需苦苦地挣扎地没日没夜的技巧学习、高级复杂函数的烧脑，最终走向了从入门到放弃的道路。

最后Excel功能强大，其实还需树立一个观点，不是所有事情都要交给Excel去完成，也不是所有事情Excel都是十分胜任的，外面的世界仍然是一个广阔的世界，Excel只是其中一枚耀眼的明星，还有其他更多同样精彩强大的技术、工具等。*Excel催化剂也将借力这些其他技术，让Excel能够发挥更强大的爆发！

关于Excel催化剂作者

姓名：李伟坚，从事数据分析工作多年（BI方向），一名同样在路上的学习者。
服务过行业：零售特别是鞋服类的零售行业，电商（淘宝、天猫、京东、唯品会）

技术路线从一名普通用户，通过Excel软件的学习，从此走向数据世界，非科班IT专业人士。
历经重重难关，终于在数据的道路上达到技术平原期，学习众多的知识不再太吃力，同时也形成了自己的一套数据解决方案（数据采集、数据加工清洗、数据多维建模、数据报表展示等）。

擅长技术领域：Excel等Office家族软件、VBA&VSTO的二次开发、Sqlserver数据库技术、Sqlserver的商业智能BI技术、Powerbi技术、云服务器布署技术等等。

2018年开始职业生涯作了重大调整，从原来的正职工作，转为自由职业者，暂无固定收入，暂对前面道路不太明朗，苦重新回到正职工作，对Excel催化剂的运营和开发必定受到很大的影响（正职工作时间内不可能维护也不可能随便把工作时间内的成果公布于外，工作外的时间也十分有限，因已而立之年，家庭责任重大）。

和广大拥护者一同期盼：Excel催化剂一直能运行下去，我所惠及的群体们能够给予支持（多留言鼓励下、转发下朋友圈推荐、小额打赏下和最重点的可以和所在公司及同行推荐推荐，让我的技术可以在贵司发挥价值，实现双赢（初步设想可以数据顾问的方式或一些小型项目开发的方式合作）。