详解COM Add In的LoadBehavior及其妙用

原创 2007年10月06日 16:02:00

详解COM Add InLoadBehavior及其妙用

            Office的所有COM Add In,包括用Shared Add In模板和VSTO Add In模板创建的,都会在注册表里面存储一些信息。对于当前用户安装的Add In,以Excel为例,对应的注册表键值存储于:My Computer/HKCU/Software/Microsoft/Office/Addins/AddInName;机器级别的Add In存储于:My Computer/HKLM/Software/Microsoft/Office/Addins/AddInName。普通的Shared Add In 键下面有3个值,DescriptionFriendlyNameLoadBehaviorVSTO Add In多出两个键值:CommandLineSafeManifestManifest是用来指向自定义代码所处的dll位置的,CommandLineSafe用来指示Add In是不是命令行安全的,会不会显示在COM Add In Dialog里面。DescriptionFriendlyName就是Add In的描述和显示的名字,没啥好说的。

                LoadBehavior是这篇文章的主角。LoadBehavior指示了该Add In的装载行为,它可以由以下几个值组合而成: (前两个中的一个+后三个中的一个)

0   = Disconnect

不装载

1   = Connected

装载

2   = Bootload

启动程序时装载

8   = DemandLoad

需要时装载

16 = ConnectFirstTime

第一次启动时装载

也就是说,当LoadBehavior02816的时候,Add In不装载;当其为1+2=3的时候,装载并且每次Office程序启动时都装载;当其为9的时候,装载,但只当用户需要时装载;17的时候,装载,只有第一次启动的时候装载。如果我们不去改动,一般而言,正常工作的Add InLoadBehavior3,但如果当Add In启动的时候发生异常,这个Add In会被软禁用(Soft Disabled)LoadBehavior的值会被改为0+2=2Add In将不被装载。注意,虽然这里的值是2,表示启动时装载,但事实上,其是由0+2所得,大的前提决定了不装载。

 

那我说的LoadBehavior的妙用在何处呢?这源于最近碰到的一个问题,有人问我,能不能用代码来获取Office中被硬禁用(Hard Disable)COM Add In,或者至少知道,有没有被硬禁用的Add In?这个问题有点棘手,因为Office对象模型中,根本找不到任何信息。Google甚至都找不到,有人有类似的要求。

           在给出解决方案前,有必要讲述一下,上面提到的硬禁用和软禁用的区别。首先,硬禁用和软禁用的表象就不一样,被软禁用的Add In会出现在COM Add-Ins对话框中,只不过前面的Checkbox不会被勾上。被硬禁用的Add In虽然也会出现在COM Add-Ins对话框中,但它们会被单独再列到另外一个叫Disabled Items的对话框里面。下面是COM Add-Ins对话框和Disabled Items对话框的截图。由下面的图可以看出来ExcelAddInExcelAddIn1是被用户手动禁用,或者被软禁用的;ExcelAddIn2则是被硬禁用的。

COM Add-Ins对话框截图

Disabled Items对话框截图

那是什么导致Add In被软禁用和硬禁用的呢?为了模拟出问题,并解决,我也必须让自己的机器上出现一个被软禁用,一个被硬禁用的Add In

                软禁用:当Add In在构造函数或者Startup event handle函数里面抛出一个没有处理的异常的时候,系统将该Add In软禁用,将其LoadBehavior值改为2。要重现一个软禁用很简单,在Startup event handle里面抛出一个异常就可以了,代码如下:

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

        {

           throw new Exception("Make the Add in disabled");

        }

                硬禁用:发生在,Add In装载时由于严重的错误导致应用程序关闭,或者在构造函数或Startup event handle函数执行时,强行关掉Visual Studio Debugger时。这将导致再一次启动应用程序的时候,Office向用户询问是否硬禁用当前Add In。方法同样很简单,用一个MessageBox停住Startup event handle函数的执行过程,然后强行关掉Visual Studio,下次程序(本例Excel)启动时,选择禁用Add In

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

        {

            MessageBox.Show("Stop here");

        }

 

                接下来,看看上面问题的解决方案。在Office对象模型中,Application对象有个COMAddIns属性,它是一个集合,包括了当前应用程序中所有注册过的COM Add In,无论这个Add In是否激活。我们可以在这个集合中循环,得到每个COMAddIn的句柄,而COMAddIn又暴露了一些有用的属性,比如Connect属性。当Connect返回true时,说明这个Add In是激活的,如果返回false,说明这个Add In未激活,有可能是被用户手动禁用了,还有可能是被软禁用或硬禁用了。但是COMAddIn的属性只告诉我们这么多,通过Office对象模型,我们无法分辨,应用程序中是否存在被硬禁用的Add In,如果有,哪些是被硬禁用的Add In。通过查看硬禁用的Add In在注册表中LoadBehavior的值,惊奇地发现,硬禁用的Add In,其LoadBehavior值竟然为3!这样我们就可以结合COMAddIns集合和注册表里LoadBehavior的信息来判断哪些COM Add In是被硬禁用的,哪些是由于软禁用或者其它原因未被装载的。实现的代码如下:       

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

        {

            RegistryKey key = null;

 

            foreach(Office.COMAddIn cAddin in this.Application.COMAddIns)

            {

                if (!cAddin.Connect)

                {

                    try

                    {

                        key = Registry.LocalMachine;

                        key = key.OpenSubKey("Software").OpenSubKey("Microsoft")

                        .OpenSubKey("Office").OpenSubKey("Excel").OpenSubKey("Addins")

                        .OpenSubKey(cAddin.ProgId);

                        if (Convert.ToInt32(key.GetValue("LoadBehavior")) == 3)

                        {

                            MessageBox.Show(cAddin.ProgId + " is disabled!");

                        }

                        else

                        {

                            MessageBox.Show(cAddin.ProgId + " is not loaded!");

                        }

                    }

                    catch(Exception ex)

                    {

                        key = Registry.CurrentUser;

                        key = key.OpenSubKey("Software").OpenSubKey("Microsoft")

                        .OpenSubKey("Office").OpenSubKey("Excel").OpenSubKey("Addins")

                        .OpenSubKey(cAddin.ProgId);

                        if (Convert.ToInt32(key.GetValue("LoadBehavior")) == 3)

                        {

                            MessageBox.Show(cAddin.ProgId + " is disabled!");

                        }

                        else

                        {

                            MessageBox.Show(cAddin.ProgId + " is not loaded!");

                        }

                    }

                }

            }

        }

 

PS:如何显示COM Add-insDisabled Items对话框?(没有中文的Office,所以菜单和按钮都按英文版中的写法,对照着应该很好找到)

·         COM Add-ins对话框:

o   Office 2007Office Button->Excel Options->Add-Ins Tab->Choose Item COM Add-ins in the Manage DropDownList->Click Button Go

o   Office 2003Right Click the Menu->Click Customize… Button->In Commands Tab->Tools Categorie->Drag COM Add-Ins Command to one of the tool bar->Click the new added COM Add-ins Button

 

·         Disabled Items对话框:

o   Office 2007Office Button->Excel Options->Add-Ins Tab->Choose Item Disabled Items in the Manage DropDownList->Click Button Go

o   Office 2003Menu Help->About Microsoft Office Excel->Disabled Items

 

LoadBehavior

3)LoadBehavior:DWORD类型,用于描述COM加载项的加载方式,通常设置为3(1 + 2). 值 描述 0 断开,不加载...
  • wishfly
  • wishfly
  • 2011年11月17日 16:07
  • 1117

【转载】详解Office 外接程序 COM Add In的LoadBehavior及其妙用

Office的所有COM Add In,包括用Shared Add In模板和VSTO Add In模板创建的,都会在注表里面存储一些信息。对于当前用户安装的Add In,以Excel为例,对应的注册...

COM add-in for Outlook 2000/2002

  • 2006年02月23日 09:05
  • 129KB
  • 下载

用Add-in Express .NET创建一个COM加载项项目

用Add-in Express for Office and .NET创建一个COM加载项项目的操作并不复杂,下面将会讲述如何创建一个COM加载项项目。 在运行Visual Studio前确保你有管...

Office COM add-in 开发(一)

Office 的 add-in 分为两类,一类是application add-in,一类是 COM add-in. COM add-in 是一个进程内的COM server,需要实现 IDTExen...

桌面定制开发COM方式到Add-In方式的迁移

http://bbs.esrichina-bj.cn/ESRI/viewthread.php?tid=105152   com方式定制         http://bbs.esrichin...

QS Add On Huawei_v9.0.2204_apkpure.com.apk

  • 2016年05月25日 19:50
  • 129KB
  • 下载

Microsoft Excel Add-in (excel QC)

  • 2017年11月12日 21:33
  • 14.47MB
  • 下载
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:详解COM Add In的LoadBehavior及其妙用
举报原因:
原因补充:

(最多只允许输入30个字)