如何在Outlook AddIn的Ribbon中实现CallBack回调方法

现有代码可直接修正的问题 #

• 你写的自定义CallBack委托、EnumWindows调用属于无效代码，VSTO Ribbon回调不需要自定义委托，这两行直接删除即可，留着会报语法错误。
• 现有复选框的onAction逻辑完全写反：点击时把当前字段值赋值给自身，永远不会切换状态。
• 复选框缺少getPressed回调，Ribbon加载时无法正确显示初始勾选状态。
• 所有配置字段没给初始值，第一次加载时会触发空引用报错。

回调方法具体实现 #

Ribbon回调不需要特殊的委托绑定，只要方法签名和Office约定一致，在Ribbon XML里填对方法名就能自动触发。

第一步：补全构造函数初始化 #

先给所有字段加默认值，避免运行时报错：

public RibbonSettings()
{
    m_internalDomains = new StringCollection();
    m_anhangBlacklist = new StringCollection();
    m_vertraulichkeitsvermerk = string.Empty;
    // 功能开关默认值可按需调整，这里默认全部关闭
    m_attachmentCheck = false;
    m_confidentialCheck = false;
    m_externalCheck = false;
    m_recipientCheck = false;
    m_nameCheck = false;
    m_timedelayedCheck = false;
    // 所有EL选项默认不勾选
    for (int i = 0; i < m_lines.Length; i++)
    {
        m_lines[i] = false;
    }
}

第二步：实现复选框两类回调 #

你那几个功能开关都是复选框控件，需要配两个回调：

• getPressed：Ribbon加载、刷新时自动调用，返回布尔值决定复选框是否显示为勾选状态
• onAction：用户点击复选框时触发，传入最新的勾选状态，更新本地存储的字段值
  直接替换你之前写的几个OnXXXCheck方法：

#region 功能开关回调
// 附件检查
public bool GetAttachmentCheckPressed(Office.IRibbonControl control)
{
    return m_attachmentCheck;
}
public void OnAttachmentCheck(Office.IRibbonControl control, bool isPressed)
{
    m_attachmentCheck = isPressed;
    // 如果需要联动刷新其他Ribbon控件状态，取消下一行注释
    // ribbon.Invalidate();
}

// 机密内容检查
public bool GetConfidentialCheckPressed(Office.IRibbonControl control)
{
    return m_confidentialCheck;
}
public void OnConfidentialCheck(Office.IRibbonControl control, bool isPressed)
{
    m_confidentialCheck = isPressed;
}

// 外部收件人检查
public bool GetExternalCheckPressed(Office.IRibbonControl control)
{
    return m_externalCheck;
}
public void OnExternalCheck(Office.IRibbonControl control, bool isPressed)
{
    m_externalCheck = isPressed;
}

// 收件人校验
public bool GetRecipientCheckPressed(Office.IRibbonControl control)
{
    return m_recipientCheck;
}
public void OnRecipientCheck(Office.IRibbonControl control, bool isPressed)
{
    m_recipientCheck = isPressed;
}

// 姓名校验
public bool GetNameCheckPressed(Office.IRibbonControl control)
{
    return m_nameCheck;
}
public void OnNameCheck(Office.IRibbonControl control, bool isPressed)
{
    m_nameCheck = isPressed;
}

// 延迟发送检查
public bool GetTimedelayedCheckPressed(Office.IRibbonControl control)
{
    return m_timedelayedCheck;
}
public void OnTimeDelayedCheck(Office.IRibbonControl control, bool isPressed)
{
    m_timedelayedCheck = isPressed;
}
#endregion

对应的Ribbon XML里复选框要配上这两个回调属性，示例：

<checkBox id="chkAttachment" label="附件检查" getPressed="GetAttachmentCheckPressed" onAction="OnAttachmentCheck"/>

第三步：调整按钮类回调 #

你写的几个打开配置窗口的按钮回调逻辑基本可用，建议把Show()改成ShowDialog()打开模态窗口，加using自动释放窗体资源，避免用户重复打开多个配置页：

public void OnInternalDomains(Office.IRibbonControl control)
{
    using (form_internalDomains form = new form_internalDomains(m_internalDomains))
    {
        form.ShowDialog();
        m_internalDomains = form.get_internalDomains();
    }
}

public void OnAnhangBlacklist(Office.IRibbonControl control) 
{
    using (form_anhangBlacklist form = new form_anhangBlacklist(m_anhangBlacklist))
    {
        form.ShowDialog();
        m_anhangBlacklist = form.get_anhangBlacklist();
    }
}

public void OnVertraulichkeitsvermerk(Office.IRibbonControl control)
{
    using (form_vertraulichkeitsvermerk form = new form_vertraulichkeitsvermerk(m_vertraulichkeitsvermerk))
    {
        form.ShowDialog();
        m_vertraulichkeitsvermerk = form.get_vertraulichkeitsvermerk();
    }
}

其他回调说明 #

• 你写的EL3到EL24的方法本身就是标准的getPressed回调，直接在Ribbon XML里对应复选框的getPressed属性填对应方法名即可，不需要修改。
• 版权链接的OnLinkCopyright方法符合超链接控件的getTarget回调签名，XML里对应超链接控件配置getTarget="OnLinkCopyright"就能正常跳转。
• Ribbon_Load回调已经正确实现，不需要修改。

开发注意事项 #

• 所有回调方法必须是public类型，方法签名必须和Office要求完全匹配，多一个少一个参数都不会触发。
• 如果修改配置后需要强制刷新Ribbon显示，调用ribbon.Invalidate()即可，Office会重新执行所有get类回调拉取最新状态。
• 你现在写的get_xxx/set_xxx是Java风格写法，C#原生支持属性语法，不过不影响功能运行，可以按需重构，不调整也没关系。

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