VB.Net Outlook加载项：功能区ToggleButton与注册表设置同步

1. 功能区控件状态绑定注册表值 #

由于XML构建的功能区无法直接操作控件，需通过IRibbonUI的回调机制实现状态同步：

步骤1：声明全局IRibbonUI变量 #

在加载项的代码模块中添加：

Private ribbonUI As IRibbonUI

步骤2：配置功能区XML的回调事件 #

修改你的功能区XML，添加onLoad绑定和ToggleButton的getPressed回调：

<customUI xmlns="http://schemas.microsoft.com/office/2009/07/customui" onLoad="Ribbon_Load">
  <ribbon>
    <tabs>
      <tab id="CustomTab" label="我的加载项">
        <group id="CustomGroup" label="设置">
          <toggleButton id="SettingsToggle" label="开关设置" getPressed="GetTogglePressed" onAction="ToggleButton_Click"/>
        </group>
      </tab>
    </tabs>
  </ribbon>
</customUI>

步骤3：实现回调方法 #

• 保存IRibbonUI实例：

Sub Ribbon_Load(ribbon As IRibbonUI)
    Set ribbonUI = ribbon
End Sub

• 读取注册表值返回按钮状态：

Function GetTogglePressed(control As IRibbonControl) As Boolean
    ' 替换为你的AppName、Section和KeyName
    GetTogglePressed = GetSetting(AppName:="MyOutlookAddin", Section:="Settings", Key:="ToggleState", Default:=False)
End Function

每次功能区加载或刷新时，按钮会自动从注册表读取最新状态。

2. 监听注册表变更自动刷新功能区 #

为了捕获其他途径修改注册表的情况，通过Windows API实现注册表监听：

步骤1：声明API和全局变量 #

Private Declare Function RegOpenKeyEx Lib "advapi32.dll" Alias "RegOpenKeyExA" (ByVal hKey As Long, ByVal lpSubKey As String, ByVal ulOptions As Long, ByVal samDesired As Long, phkResult As Long) As Long
Private Declare Function RegNotifyChangeKeyValue Lib "advapi32.dll" (ByVal hKey As Long, ByVal bWatchSubtree As Long, ByVal dwNotifyFilter As Long, ByVal hEvent As Long, ByVal fAsynchronous As Long) As Long
Private Declare Function RegCloseKey Lib "advapi32.dll" (ByVal hKey As Long) As Long
Private Declare Function CreateEvent Lib "kernel32.dll" Alias "CreateEventA" (ByVal lpEventAttributes As Long, ByVal bManualReset As Long, ByVal bInitialState As Long, ByVal lpName As String) As Long
Private Declare Function WaitForSingleObject Lib "kernel32.dll" (ByVal hHandle As Long, ByVal dwMilliseconds As Long) As Long

Private Const HKEY_CURRENT_USER = &H80000001
Private Const KEY_QUERY_VALUE = &H1
Private Const KEY_NOTIFY = &H10
Private Const REG_NOTIFY_CHANGE_LAST_SET = &H1
Private Const INFINITE = &HFFFFFFFF

Private hRegKey As Long
Private hEvent As Long

步骤2：启动注册表监听 #

在加载项启动时初始化监听：

Private Sub ThisAddIn_Startup()
    StartRegistryWatcher
End Sub

Sub StartRegistryWatcher()
    ' GetSetting默认存储路径：HKEY_CURRENT_USER\Software\VB and VBA Program Settings\AppName\Section
    Dim regPath As String
    regPath = "Software\VB and VBA Program Settings\MyOutlookAddin\Settings"
    
    If RegOpenKeyEx(HKEY_CURRENT_USER, regPath, 0, KEY_QUERY_VALUE Or KEY_NOTIFY, hRegKey) = 0 Then
        hEvent = CreateEvent(0, True, False, "RegWatchEvent")
        RegNotifyChangeKeyValue hRegKey, False, REG_NOTIFY_CHANGE_LAST_SET, hEvent, True
        Call CheckRegistryChange
    End If
End Sub

Sub CheckRegistryChange()
    Dim result As Long
    result = WaitForSingleObject(hEvent, 100)
    If result = 0 Then
        ' 刷新目标ToggleButton
        If Not ribbonUI Is Nothing Then
            ribbonUI.InvalidateControl "SettingsToggle"
        End If
        ' 重新注册监听
        RegNotifyChangeKeyValue hRegKey, False, REG_NOTIFY_CHANGE_LAST_SET, hEvent, True
    End If
    ' 定时循环检查
    Application.OnTime Now + TimeValue("00:00:00.1"), "CheckRegistryChange"
End Sub

步骤3：关闭加载项时清理资源 #

Private Sub ThisAddIn_Shutdown()
    If hRegKey <> 0 Then
        RegCloseKey hRegKey
    End If
    ' 取消定时任务
    On Error Resume Next
    Application.OnTime Now + TimeValue("00:00:00.1"), "CheckRegistryChange", , False
    On Error GoTo 0
End Sub

3. 任务栏按钮修改后的同步 #

在任务栏ToggleButton的点击事件中，修改注册表后直接触发功能区刷新：

Sub TaskbarToggle_Click()
    Dim currentState As Boolean
    currentState = GetSetting(AppName:="MyOutlookAddin", Section:="Settings", Key:="ToggleState", Default:=False)
    SaveSetting AppName:="MyOutlookAddin", Section:="Settings", Key:="ToggleState", Setting:=Not currentState
    
    ' 立即刷新功能区按钮
    If Not ribbonUI Is Nothing Then
        ribbonUI.InvalidateControl "SettingsToggle"
    End If
End Sub

内容的提问来源于stack exchange，提问作者Albin Gyllander