使用C＃编写的COM加载项与自动加载项的可选参数

Question

我正在开发一个COM加载项和Excel自动化加载项库，其核心代码是用C＃编写的。我想为函数设置一个可选参数，我知道这对于C＃和VBA，甚至Excel WorksheetFunction都是合法的。但我发现最终可选参数专门用于COM和Automation加载项，这意味着如果首先运行一个加载项，那么效果很好，但另一个加载项的可选参数将不起作用。

下面请看示例：

在VS 2013解决方案中，我有两个项目：一个名为TestVBA，另一个名为TestExcel。

TestVBA用于COM加载项并通过“Excel 2013加载项”构建，并且有两个.cs文件：

1. ThisAddIn.cs

此文件自动生成并稍作修改。代码是

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Xml.Linq;
using Excel = Microsoft.Office.Interop.Excel;
using Office = Microsoft.Office.Core;
using Microsoft.Office.Tools.Excel;

namespace TestVBA
{
    public partial class ThisAddIn
    {
        private void ThisAddIn_Startup(object sender, System.EventArgs e)
        {
        }

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

        private ExcelVBA oExcelVBA;

        protected override object RequestComAddInAutomationService()
        {
            if (oExcelVBA == null)
            {
                oExcelVBA = new ExcelVBA();
            }
            return oExcelVBA;
        }
        #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);
        }

        #endregion
    }
}

2. TestVBA.cs

此文件是COM加载项的主要计算文件。代码是

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

using System.Runtime.InteropServices;
using Excel = Microsoft.Office.Interop.Excel;

using System.Reflection;


namespace TestVBA
{
    [ComVisible(true)]
    [ClassInterface(ClassInterfaceType.AutoDual)]
    public class ExcelVBA
    {
        public int TestAddVBA(int a = 1, int b = 1)
        {
            return a + b;
        }
    }
}

另一个TestExcel用于Excel Automation加载项并通过C＃“类库”构建，并且有两个.cs文件：

1. BaseUDF.cs

此文件定义了两个属性的装饰。代码是

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

using System.Runtime.InteropServices;
using Microsoft.Win32;

namespace BaseUDF
{
    [ClassInterface(ClassInterfaceType.AutoDual)]
    [ComVisible(true)]
    public abstract class BaseUDF
    {
        [ComRegisterFunctionAttribute]
        public static void RegisterFunction(Type type)
        {
            // Add the "Programmable" registry key under CLSID.
            Registry.ClassesRoot.CreateSubKey(
              GetSubKeyName(type, "Programmable"));
            // Register the full path to mscoree.dll which makes Excel happier.
            RegistryKey key = Registry.ClassesRoot.OpenSubKey(
              GetSubKeyName(type, "InprocServer32"), true);
            key.SetValue("",
              System.Environment.SystemDirectory + @"\mscoree.dll",
              RegistryValueKind.String);
        }

        [ComUnregisterFunctionAttribute]
        public static void UnregisterFunction(Type type)
        {
            // Remove the "Programmable" registry key under CLSID.
            Registry.ClassesRoot.DeleteSubKey(
              GetSubKeyName(type, "Programmable"), false);
        }

        private static string GetSubKeyName(Type type,
          string subKeyName)
        {
            System.Text.StringBuilder s =
              new System.Text.StringBuilder();
            s.Append(@"CLSID\{");
            s.Append(type.GUID.ToString().ToUpper());
            s.Append(@"}\");
            s.Append(subKeyName);
            return s.ToString();
        }

        // Hiding these methods from Excel.
        [ComVisible(false)]
        public override string ToString()
        {
            return base.ToString();
        }

        [ComVisible(false)]
        public override bool Equals(object obj)
        {
            return base.Equals(obj);
        }

        [ComVisible(false)]
        public override int GetHashCode()
        {
            return base.GetHashCode();
        }
    }
}

2. TestExcel.cs

此文件是Excel Automation加载项的主要计算文件。代码是

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

using Microsoft.Win32;
using System.Runtime.InteropServices;
using Excel = Microsoft.Office.Interop.Excel;
using Extensibility;

namespace TestExcel
{
    [Guid("7127696E-AB87-427a-BC85-AB3CBA301CF3")]
    [ClassInterface(ClassInterfaceType.AutoDual)]
    [ComVisible(true)]
    public class TestExcel : BaseUDF.BaseUDF
    {
        public int TestAddExcel(int a = 1, int b = 1)
        {
            return a + b;
        }
    }
}

构建之后，两个加载项已在系统中注册，在Excel中我们可以成功使用它们。

对于自动化插件，我们在电子表格中将它们称为=TestAddExcel(2,3)和=TestAddExcel()，它们都能很好地工作并提供正确的结果5和2。但是，当我尝试通过COM调用COM加载项时

Sub TestVBA_Click()

Dim addIn As COMAddIn
Dim TesthObj As Object

Set addIn = Application.COMAddIns("TestVBA")
Set TestObj = addIn.Object

Range("Output").Value2 = TestObj.TestAddVBA(2, 3)
Range("Output").Offset(1, 0).Value2 = TestObj.TestAddVBA()

End Sub

存在所有参数的第一次调用运行良好，但对于缺少参数的第二次调用显示错误Type mismatch。

有趣的是，当我关闭测试excel文件并再次打开它时，这次我首先测试COM加载项，仍然通过上面的VBA代码，两个调用都工作得很好。然后，当我测试过去运行良好的两个电子表格函数时，只有第一个是好的，第二个参数缺少=TestAddExcel()失败了#VALUE!。

如果有人可以帮助解决这个奇怪的问题，那将是非常好的。

Answer 1

我不确定你如何在没有注册COM的情况下引用类库？我现在看到，你正在使用Late Binding。我不知道你能做到这一点（不认为它会让你）并怀疑这是问题，它也匹配Type mismatch错误。

按照我的canonical answer here on the 3 methods to call .Net from Excel or VBA中的第二个解决方案，确保注册COM：

单击Build选项卡，选中“Register for COM Interop”复选框。此时，如果您在Windows Vista或更高版本上运行，则还有一个额外的步骤。必须以管理员权限运行Visual Studio才能注册COM Interop。保存项目并退出Visual Studio。然后在“开始”菜单中找到Visual Studio并右键单击它并选择“以管理员身份运行”。在Visual Studio中重新打开您的项目。然后选择“Build”来构建加载项。

---

（可选）如果以上方法不起作用，请按照我的答案中的第三个解决方案并引用自动化加载项并使用早期绑定，我已经对此进行了测试并且它完美地运行：

Sub TestVBA1_Click()

Dim addIn As COMAddIn
Dim TesthObj As Object

Set addIn = Application.COMAddIns("TestVBA")
Set TestObj = addIn.Object

Debug.Print TestObj.TestAddVBA(2, 3)
Debug.Print TestObj.TestAddVBA()


Dim dotNetClass As TestExcel.TestExcel
Set dotNetClass = New TestExcel.TestExcel

Debug.Print dotNetClass.TestAddExcel(7, 3)
Debug.Print dotNetClass.TestAddExcel()

End Sub

Answer 2

这是一个黑暗中的总刺，但是你可以创建方法的重载版本来模仿在C＃具有可选参数之前完成此操作的方式，看看它是否有效？

public int TestAddExcel(int a, int b)
{
    return a + b;
}

public int TestAddExcel(int a)
{
    return a + 1;
}

public int TestAddExcel()
{
    return 2;
}