使用 VB.NET 为 VBA IDE 构建插件

Question

我在其他地方问过这个问题，但从未发现有人知道如何使用 VB.NET 为 VBA IDE 构建插件。有可能吗？有人能给我举个例子吗？

Answer 1

您可能需要使用 IDTExtensibility2 接口编写 com 插件，从新项目中选择共享插件项目模板。

编辑

否则，要从头开始创建此插件，您将需要执行以下操作：

1. 创建一个新的项目类库
2. 添加对“扩展性”的引用，它应该在列表中。您可能需要下载适合您的 Office 版本的 PIA。 （也许还有 VSTO，但我对此不确定）
3. 再次添加对“Microsoft.Vbe.Interop”的引用应该与 PIA 一起使用。
4. 选中属性选项卡中的“Register for Com Interop”框。
5. 可选在调试设置选项卡中，将启动更改为外部程序，并在programfiles文件夹中输入excel exe的路径（如果这是针对excel的），这是为了允许项目可调试。
6. 可选 在命令选项中添加一个条目到工作表或 Word 文档，该条目将在启动时使用宏显示插件对话框，对于开发来说，这对于简化调试体验很有意义。例如“C:\vbe.xlsm”
7. 可选 还要设置工作表目录的启动路径，例如“C:\”
8. 实现“Extensibility”程序集中的接口“IDTExtensibility2”。
9. 将此类命名为“Connect”（这只是一个首选项）
10. 使用以下属性为该类添加属性

[ComVisible(true),
Guid("您生成的Guid"),
ProgId("YourAddinName.Connect")]

这是一个帮助您入门的实现，首先将“YourAddinName”替换为您的AppName，并为“YourGenerateGuid”创建一个Guid。
您需要将插件注册到正确的注册表位置，查看后面的注册表项以了解情况，还需要替换注册表项中的一些变量。

Imports System
Imports System.Drawing
Imports System.Linq
Imports System.Runtime.InteropServices
Imports Extensibility
Imports Microsoft.Vbe.Interop

Namespace VBEAddin


''' <summary>
''' The object for implementing an Add-in.
''' </summary>
''' <seealso class='IDTExtensibility2' />
<Guid("YourGeneratedGuid"), ProgId("YourAddinName.Connect")> _ 
Public Class Connect
    Implements IDTExtensibility2
    Private _application As VBE 'Interop VBE application object


    #Region "IDTExtensibility2 Members"

    ''' <summary>
    ''' Implements the OnConnection method of the IDTExtensibility2 interface.
    ''' Receives notification that the Add-in is being loaded.
    ''' </summary>
    ''' <param term='application'>
    ''' Root object of the host application.
    ''' </param>
    ''' <param term='connectMode'>
    ''' Describes how the Add-in is being loaded.
    ''' </param>
    ''' <param term='addInInst'>
    ''' Object representing this Add-in.
    ''' </param>
    ''' <seealso class='IDTExtensibility2' />
    Public Sub OnConnection(ByVal application As Object, ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object, ByRef [custom] As Array)
    _application = CType(Application,VBE)
    End Sub

    Private Sub onReferenceItemAdded(ByVal reference As Reference)
        'TODO: Map types found in assembly using reference.
    End Sub

    Private Sub onReferenceItemRemoved(ByVal reference As Reference)
        'TODO: Remove types found in assembly using reference.
    End Sub


    Private Sub BootAddin()
        'Detect change in active window. 
    End Sub

    ''' <summary>
    ''' Implements the OnDisconnection method of the IDTExtensibility2 interface.
    ''' Receives notification that the Add-in is being unloaded.
    ''' </summary>
    ''' <param term='disconnectMode'>
    ''' Describes how the Add-in is being unloaded.
    ''' </param>
    ''' <param term='custom'>
    ''' Array of parameters that are host application specific.
    ''' </param>
    ''' <seealso class='IDTExtensibility2' />
    Public Sub OnDisconnection(ByVal disconnectMode As ext_DisconnectMode, ByRef [custom] As Array)
    End Sub

    ''' <summary>
    ''' Implements the OnAddInsUpdate method of the IDTExtensibility2 interface.
    ''' Receives notification that the collection of Add-ins has changed.
    ''' </summary>
    ''' <param term='custom'>
    ''' Array of parameters that are host application specific.
    ''' </param>
    ''' <seealso class='IDTExtensibility2' />
    Public Sub OnAddInsUpdate(ByRef [custom] As Array)
    End Sub

    ''' <summary>
    ''' Implements the OnStartupComplete method of the IDTExtensibility2 interface.
    ''' Receives notification that the host application has completed loading.
    ''' </summary>
    ''' <param term='custom'>
    ''' Array of parameters that are host application specific.
    ''' </param>
    ''' <seealso class='IDTExtensibility2' />
    Public Sub OnStartupComplete(ByRef [custom] As Array)
        'Boot dispatcher

    End Sub


    ''' <summary>
    ''' Implements the OnBeginShutdown method of the IDTExtensibility2 interface.
    ''' Receives notification that the host application is being unloaded.
    ''' </summary>
    ''' <param term='custom'>
    ''' Array of parameters that are host application specific.
    ''' </param>
    ''' <seealso class='IDTExtensibility2' />
    Public Sub OnBeginShutdown(ByRef [custom] As Array)
    End Sub

    #End Region
End Class
End Namespace

这是用于注册插件的注册表 .key 脚本，请注意，您将需要更改一些设置才能正确注册它。

Windows Registry Editor Version 5.00

[HKEY_CURRENT_USER\Software\Microsoft\VBA\VBE\6.0\Addins\YourAddinName.Connect]
"CommandLineSafe"=dword:00000000
"Description"="Description for your new addin"
"LoadBehavior"=dword:00000000
"FriendlyName"="YourAddinName"


[HKEY_CLASSES_ROOT\CLSID\{YourGeneratedGuid}]
@="YourAddinName.Connect"

[HKEY_CLASSES_ROOT\CLSID\{YourGeneratedGuid}\Implemented Categories]

[HKEY_CLASSES_ROOT\CLSID\{YourGeneratedGuid}\InprocServer32]
@="mscoree.dll"
"ThreadingModel"="Both"
"Class"="YourAddinName.Connect"
"Assembly"="YourAssemblyNameFullTypeName"
"RuntimeVersion"="v2.0.50727"
"CodeBase"="file:///PathToAssembly"

[HKEY_CLASSES_ROOT\CLSID\{YourGeneratedGuid}\ProgId]
@="YourAddinName.Connect"

注意 标记“YourGenerateGuid”必须包含大括号 {}，并且与上面 attrib 中的 Guid 相同，标记“YourAssemblyNameFullTypeName”必须是程序集全名，标记“YourAddinName”必须是程序集全名。 Connect”必须与上面属性中设置的 ProgId 相同。

旁注

还发现这很有帮助，可能会节省您几个小时的谷歌搜索时间。

'HKEY_CURRENT_USER\Software\Microsoft\VBA\6.0\Common
'FontFace=Courier New (STRING - Default if missing)
'FontHeight=10 (DWORD - Default if missing)                

Answer 2

不幸的是，almog.ori 的步骤对我不起作用。这是我的版本，以帮助将来的人们：

1. 创建一个名为“VBEAddIn”的 C# 或 VB.NET 类库项目

   使用“项目”、“添加引用...”菜单、“浏览”选项卡添加以下 Interop 程序集作为对项目的引用。

2. 扩展性 (C:\Program Files\Microsoft Visual Studio 10.0\Visual Studio Tools for Office\PIA\Common\Extensibility.dll) - 如果不存在，请尝试 C:\Program Files (x86)\ if您使用的是 x64 PC。

3. Microsoft.Office.Interop.Excel (C:\Program Files\Microsoft Visual Studio 10.0\Visual Studio Tools for Office\PIA \Office14\Microsoft.Office.Interop.Excel.dll)

4. Microsoft.Vbe.Interop (C:\Program Files\Microsoft Visual Studio 10.0\Visual Studio Tools for Office\PIA\Office14\Microsoft.Vbe.Interop.dll)

5. （可选）Microsoft.Vbe.Interop.Forms (C:\ Program Files\Microsoft Visual Studio 10.0\Visual Studio Tools for Office\PIA\Office14\Microsoft.Vbe.Interop.Forms.dll)

使用以下代码将类添加到项目中：

VB.Net:

Imports Microsoft.Office.Interop
Imports Extensibility
Imports System.Windows.Forms
Imports System.Runtime.InteropServices
Imports Microsoft.Vbe.Interop

<ComVisible(True), Guid("3599862B-FF92-42DF-BB55-DBD37CC13565"), ProgId("VBEAddInVB.Net.Connect")> _
Public Class Connect
    Implements Extensibility.IDTExtensibility2

    Private _VBE As VBE
    Private _AddIn As AddIn

    Private Sub OnConnection(Application As Object, ConnectMode As Extensibility.ext_ConnectMode, _
       AddInInst As Object, ByRef custom As System.Array) Implements IDTExtensibility2.OnConnection
        Try
            _VBE = DirectCast(Application, VBE)
            _AddIn = DirectCast(AddInInst, AddIn)
            Select Case ConnectMode
                Case Extensibility.ext_ConnectMode.ext_cm_Startup
                Case Extensibility.ext_ConnectMode.ext_cm_AfterStartup
                    InitializeAddIn()
            End Select
        Catch ex As Exception
            MessageBox.Show(ex.ToString())
        End Try
    End Sub

    Private Sub OnDisconnection(RemoveMode As Extensibility.ext_DisconnectMode, _
       ByRef custom As System.Array) Implements IDTExtensibility2.OnDisconnection

    End Sub

    Private Sub OnStartupComplete(ByRef custom As System.Array) _
       Implements IDTExtensibility2.OnStartupComplete
        InitializeAddIn()
    End Sub

    Private Sub OnAddInsUpdate(ByRef custom As System.Array) Implements IDTExtensibility2.OnAddInsUpdate

    End Sub

    Private Sub OnBeginShutdown(ByRef custom As System.Array) Implements IDTExtensibility2.OnBeginShutdown

    End Sub

    Private Sub InitializeAddIn()
        MessageBox.Show(_AddIn.ProgId & " loaded in VBA editor version " & _VBE.Version)
    End Sub

End Class

C# ：

using System;
using System.Collections;
using System.Collections.Generic;
using System.Data;
using System.Diagnostics;
using System.Linq;
using System.Runtime.InteropServices;
using Extensibility;
using Microsoft.Vbe.Interop;
using System.Windows.Forms;

namespace VBEAddin
{
    [ComVisible(true), Guid("3599862B-FF92-42DF-BB55-DBD37CC13565"), ProgId("VBEAddIn.Connect")]
    public class Connect : IDTExtensibility2
    {
        private VBE _VBE;
        private AddIn _AddIn;

        #region "IDTExtensibility2 Members"

        public void OnConnection(object application, ext_ConnectMode connectMode, object addInInst, ref Array custom)
        {
            try 
            {
                _VBE = (VBE)application;
                _AddIn = (AddIn)addInInst;

                switch (connectMode) 
                {
                    case Extensibility.ext_ConnectMode.ext_cm_Startup:
                        break;
                    case Extensibility.ext_ConnectMode.ext_cm_AfterStartup:
                        InitializeAddIn();

                        break;
                }
            }
            catch (Exception ex) 
            {
                MessageBox.Show(ex.ToString());
            }
        }

        private void onReferenceItemAdded(Reference reference)
        {
            //TODO: Map types found in assembly using reference.
        }

        private void onReferenceItemRemoved(Reference reference)
        {
            //TODO: Remove types found in assembly using reference.
        }

        public void OnDisconnection(ext_DisconnectMode disconnectMode, ref Array custom)
        {
        }

        public void OnAddInsUpdate(ref Array custom)
        {
        }

        public void OnStartupComplete(ref Array custom)
        {
              InitializeAddIn();
        }

        private void InitializeAddIn()
        {
            MessageBox.Show(_AddIn.ProgId + " loaded in VBA editor version " + _VBE.Version);
        }

        public void OnBeginShutdown(ref Array custom)
        {
        }

        #endregion
    }
}

在项目的“项目属性”窗口中：

1. 在“应用程序”选项卡中，确保程序集名称和根命名空间都设置为“VBEAddIn”。

2. 在“编译”选项卡中，确保选中“注册 COM 互操作”复选框。我们不会费心使用适当的 regasm.exe 工具手动注册 COM Interop 程序集。但请注意，“注册 COM 互操作”复选框只会将加载项 dll 注册为 32 位 COM 库，而不是 64 位 COM 库。

3. 在“编译”选项卡的“高级编译选项”按钮中，确保“目标 CPU”组合框设置为“AnyCPU”，这意味着程序集可以作为 64 位或 32 位执行，具体取决于在加载它的执行 .NET Framework 上。

4. 在“签名”选项卡中，确保未选中“对程序集进行签名”。

接下来添加注册表项，将以下代码片段保存为带有 reg 扩展名的 ASCI 文件，然后双击它以将值添加到注册表中。

重要提示：在执行 reg 文件之前，请更改路径： "CodeBase"="file:///C:\Dev\VBEAddIn\VBEAddIn\bin\Debug\VBEAddIn.dll

Windows Registry Editor Version 5.00

[HKEY_CURRENT_USER\Software\Microsoft\VBA\VBE\6.0\Addins\VBEAddIn.Connect]
"CommandLineSafe"=dword:00000000
"Description"="Description for your new addin"
"LoadBehavior"=dword:00000000
"FriendlyName"="VBEAddIn"


[HKEY_CLASSES_ROOT\CLSID\{3599862B-FF92-42DF-BB55-DBD37CC13565}]
@="VBEAddIn.Connect"

[HKEY_CLASSES_ROOT\CLSID\{3599862B-FF92-42DF-BB55-DBD37CC13565}\Implemented Categories]

[HKEY_CLASSES_ROOT\CLSID\{3599862B-FF92-42DF-BB55-DBD37CC13565}\InprocServer32]
@="mscoree.dll"
"ThreadingModel"="Both"
"Class"="VBEAddIn.Connect"
"Assembly"="VBEAddIn"
"RuntimeVersion"="v2.0.50727"
"CodeBase"="file:///C:\Dev\VBEAddIn\VBEAddIn\bin\Debug\VBEAddIn.dll"

[HKEY_CLASSES_ROOT\CLSID\{3599862B-FF92-42DF-BB55-DBD37CC13565}\ProgId]
@="VBEAddIn.Connect"

1. " Visual Studio 中的 VBE 插件并打开 Excel。
2. 打开其 VBA 编辑器 (Alt + F11)。
3. 转到“加载项”、“加载项管理器...”菜单检查加载项是否已正确注册。
4. 加载加载项。您应该看到消息框“VBEAddIn.Connect 在 VBA 编辑器中加载”

---

如果出现此错误：

无法加载“VBEAddIn”。

将其从可用加载项列表中删除吗？

您可能没有更改路径“CodeBase”=“file:///C:\Dev\VBEAddIn\VBEAddIn\bin\Debug\VBEAddIn.dll”

并检查 CodeBase 密钥是否在注册表中（添加一个字符串regkey 与代码库（如果不存在）：

然后关闭 Office 应用程序，从 Visual Studio 再次构建 VBE AddIn，打开 Office（Excel、Outlook、Word 等）并按 Alt + F11，插件菜单>插件管理器并选择插件并勾选已加载/已卸载。

解决此问题的最后一个技巧：

如果仍然失败，请关闭 Office 应用程序，转到 Visual Studio，“项目属性”>“构建选项卡>勾选“注册 COM 互操作”>构建解决方案并打开 Office Add In > Alt + F11 >插件菜单>插件管理器并单击“已加载/已卸载”。

---

这个答案使用了我修改过的 Carlo's Quintero (MZTools) 的一些信息，参考： http ://www.mztools.com/articles/2012/MZ2012013.aspx

Answer 3

我还发现此参考对于从 C# 或 VB.NET 制作 VBA DLL 很有帮助：

1. 创建一个新的 C#（或 VB.Net）项目并选择“类库”作为模板类型。

   使用系统；
   使用 System.Collections.Generic；
   使用 System.Linq；
   使用系统文本；
   
   命名空间 SimpleCalc
   {
       公开课计算
       {
           私有 int numberOne = 0;
           私有 int numberTwo = 0;
   
           公共无效SetNumberOne（int数字）
           {
               数字一 = 数字；
           }
   
           公共无效SetNumberTwo（int数字）
           {
               数字二 = 数字；
           }
   
           // 将两个整数相加
           公共 int 添加（）
           {
               返回数字一+数字二；
           }
       }
   }
   

2. 配置项目属性以使其 COM 可见。

3. 注册 COM 互操作。
4. 编译项目。
5. 将类型库文件复制到 Windows 系统文件夹。
6. 从 Access VBA 编辑器引用类型库。

7. 在 VBA 代码中使用 DLL。

   公共函数测试()
       Dim lngResult As Long
   
       Dim objCalc As SimpleCalc.Calc
       设置 objCalc = New SimpleCalc.Calc
   
       objCalc.SetNumberOne (3)
       objCalc.SetNumberTwo (6)
   
       lngResult = objCalc.Add()
   
   结束功能
   

由 GeeksEngine.com 提供

Answer 4

我想您可以从 VBA 代码中调用 .NET DLL（我自己从未真正这样做过）。只需创建一个 VB 类库项目并创建一个在 VBA 中使用的 DLL。

经过快速谷歌搜索后，您似乎需要在“项目属性”->“构建”下设置“Register for Com Interop”= True，但就像我说的，我以前从未真正尝试过这一点。

Answer 5

还要注意项目的 Guid（如果是 assamblyInfo.cs 中的 c#）与“Connect”类的 Guid 不同。

具有相同的 Guid 会导致“无法转换为类型库” - 检查时出错：Project Properties >构建选项卡>注册 COM 互操作

Answer 6

我完全同意杰里米·汤普森上面的回答。然而，我花了几个小时试图让示例 VBEAddin 工作。直到我在 Connect 类代码中注意到 ProgID 属性为“VBEAddInVB.Net.Connect”，但用于创建 .reg 文件的注册表文本中，所有对程序名称的引用均为“VBEAddIn.Connect”。因此，我尝试将 Connect 类中的 ProgId 属性更改为“VBEAddIn.Connect”，重新构建它，并且成功了！我认为名称必须一致。我希望这可以节省其他人一些时间。