VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

时间:2022-06-03 03:25:08

Excel包含很多公式,如数学、日期、文本、逻辑等公式,非常方便,可以灵活快捷的对数据进行处理,达到我们想要的效果。Excel的内置公式虽然强大,但是在ERP等系统中,往往需要进行很多业务上的计算,如收发存台账、指定年、月、部门的消耗查询等,都是需要从数据库中查询的,且和业务紧密相连。这时仅仅依靠Excel的内置公式就不够了,需要添加自定义的公式来进行这些业务计算。

测试代码下载 

本系列所有测试代码均在Visual Studio 2010 Ultimate + Office 2010 Professional Plus x64 上测试通过

转载请注明出处: http://www.cnblogs.com/*s-dotnet/archive/2011/01/16/1936871.html

 

Exel允许我们创建用户自定义函数,并用到Excel公式中。

一、VBA

不使用VSTO,只用经典的VBA就可以编写Excel自定义函数。VBA我没有研究过(接触开发较晚,错过了VBA时代),感兴趣的朋友请自行搜索,有很多示例。

 

二、XLL

XLL是Excel的加载宏文件,是一个标准dll,主要使用C++开发。为此,微软提供了Excel 2010 XLL SDK,可以在这里下载。

虽然微软官方不推荐使用.NET来开发XLL,但是有人在CodePlex上发布了一个开源项目ExcelDNA,可以使用.NET来开发XLL。不过网上有人说貌似不支持Excel 2010 x64,待后续验证。

 

三、XLW

XLW(A Wrapper for the Excel API)是一个C++语言对Excel的开发者工具包(SDK)的一个封装,简化了C++程序操作Excel文档的方法,XLW4.0已经支持Excel 2007。使用XLW可以很方便的使用C++对Excel功能进行扩展,首先它提供了一个模板生成器xlwTemplateExtractor.exe,可以生成相应的工程文件,然后又具有一个接口生成器InterfaceGenerator.exe来自动生成相应的接口包装文件(xlwWrapper.cpp),从而大大减少了只使用Excel SDK来完成XLL开发所需的相关代码,降低了开发难度,避免一些错误的产生。

官方说明只支持到Excel 2007,估计Excel 2010 x64没戏了,期待后续更新。

 

四、.NET

VSTO的出现大大提高了开发人员的效率,我们可以享受现代开发工具带来的快捷与方便。借助于COM可以使用托管代码来开发Excel自定义公式。

4.1、打开VS2010,新建一个Class Library项目:

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

 

4.2、添加COM相关的特性:

[Guid("DDE8AA59-9860-44B3-B1AF-923ABB4A8EEE")]

[ClassInterface(ClassInterfaceType.AutoDual)]

[ComVisible(true)]

注意要生成一个GUID:

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

这里我使用的LinqPad,一个轻量级的IDE,支持C#、VB.NET、Linq、F#、SQL语句,非常适合用来测试少量代码。

 

4.3、写一个简单的函数,返回两个整数的和:

public int AnotherSumFunc(int a, int b)

{

return a + b;

}

 

4.4、添加COM注册与反注册函数:

[ComRegisterFunction]

public static void RegisterFunction(Type type)

{

Registry.ClassesRoot.CreateSubKey(GetSubKeyName(type, "Programmable"));

var key = Registry.ClassesRoot.OpenSubKey(GetSubKeyName(type, "InprocServer32"), true);

key.SetValue("", Environment.SystemDirectory + @"\mscoree.dll", RegistryValueKind.String);

}

 

[ComUnregisterFunction]

public static void UnregisterFunction(Type type)

{

Registry.ClassesRoot.DeleteSubKey(GetSubKeyName(type, "Programmable"), false);

}

 

private static string GetSubKeyName(Type type, string subKeyName)

{

var s = new System.Text.StringBuilder();

s.Append(@"CLSID\{");

s.Append(type.GUID.ToString().ToUpper());

s.Append(@"}\");

s.Append(subKeyName);

return s.ToString();

}

这两个函数的格式是固定的,为了向注册表中添加必须的键值。

 

4.5、修改项目属性,取消COM注册:

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

 

4.6、编译项目。

 

4.7、32位的Excel可以选中上述复选框来自动注册,从Excel 2010 x64开始,我们需要手动注册该dll。

在DOS下输入:cd /d %windir%\Microsoft.NET\Framework64\v4.0.30319

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

 

4.8、使用regasm来注册我们的dll:

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

出现警告是因为未签名,因为是测试就没有进行签名,如果是正式部署则一定要进行签名。

 

下述说明摘自MSDN,原文地址:http://msdn.microsoft.com/zh-cn/library/tzat5yw6(v=VS.100).aspx

Regeasm.exe 是一个程序集注册工具,Regeasm.exe读取程序集中的元数据,并将所需的项添加到注册表中。注册表允许 COM 客户程序以透明方式创建 .NET Framework 类。 类一经注册,任何 COM 客户程序都可以使用它,就好像该类是一个 COM 类。 类仅在安装程序集时注册一次。 程序集中的类实例直到被实际注册时,才能从 COM 中创建。

regasm assemblyFile [options]

 

assemblyFile     

要向 COM 注册的程序集。

 

选项说明

/codebase     

在注册表中创建一个 Codebase 项。 Codebase 项指定未安装到全局程序集缓存中的程序集的文件路径。 如果随后要安装正在注册到全局程序集缓存中的程序集,则不应指定此选项。 用 /codebase 选项指定的 assemblyFile 参数必须是具有强名称的程序集。

 

/registered     

指定此工具将仅引用已经注册的类型库。

 

/asmpath:directory     

指定包含程序集引用的目录。 必须和 /regfile 选项一起使用。

 

/nologo     

取消显示 Microsoft 启动标题。

 

/regfile [:regFile]     

为程序集生成指定的 .reg 文件,该文件包含所需的注册表项。 指定此选项不更改注册表。 此选项不能与 /u 选项或 /tlb 选项一起使用。

 

/silent 或 /s     

取消显示成功消息。

 

/tlb [:typeLibFile]     

从指定的程序集生成类型库,该类型库包含在程序集中定义的可访问类型的定义。

 

/unregister 或 /u     

注销在 assemblyFile 中找到的可创建类。 省略此选项将导致 Regasm.exe 注册程序集中的可创建类。

 

/verbose     

指定详细模式;当用 /tlb 选项指定时,显示所有需要为其生成类型库的引用程序集的列表。

 

/?或 /help     

显示该工具的命令语法和选项。

 

4.9、在Excel中激活该公式

打开一个Excel文件,若尚未显示"Developer(开发人员)"选项卡,则可以通过在Ribbon – 右键 – "Custom the Ribbon" – "选中Developer"来显示:

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

 

在Developer选项卡中,点击【Add-Ins】:

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

 

点击【Automation】选择我们编写的自定义函数:

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

 

选中该函数,点击【OK】:

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

 

回到Excel中,在一个单元格的公示栏中输入:=AnotherSumFunc(1,2),回车,可以看到得到了我们期望的结果:3

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

 

4.10、删除自定义函数

若该函数我们不想要了,要删除怎么办呢?只需在CMD中反注册dll:

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

 

4.11、调试自定义函数

在项目属性的Debug选项卡中,将扩展启动程序设置为Excel 2010 x64的路径:

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

 

F5运行,会自动打开Excel,当我们输入该自定义函数时,会自动进入断点:

VSTO 学习笔记(十一)开发Excel 2010 64位自定义公式

除此之外,还可以通过附加Excel的进程来进行调试。

 

小结:

Office 2010首次推出的64位版本的Office在带给我们欣喜的同时,也带来了版本维护成本的提升。因此VSTO程序的向后兼容性就显得尤为重要,Excel自定义函数只是冰山一角。后续篇章会讨论下Office插件的兼容性问题,以及从VBA转向VSTO的解决方案。