安装加载项时自动打开任务窗格

你可以将加载项的任务窗格配置为在安装后立即启动。 这一功能增加了使用率。

提示

本文介绍了一种功能,该功能使加载项能够在最终用户 安装加载项时 打开其任务窗格。 此功能的范围限于 单个文档:安装加载项时打开的文档。 此功能不同于三个类似功能:

  • 加载项可以以编程方式将文档配置为在文档打开时自动打开加载项的任务窗格。 该技术具有 文档范围,这意味着它必须单独应用于每个文档。 有关详细信息,请参阅 自动打开包含文档的任务窗格。
  • 加载项可以以编程方式将自身配置为在文档打开时运行代码。 此功能还必须单独应用于每个文档。 有关详细信息,请参阅 将文档配置为在打开时运行代码。
  • 可以在清单中配置加载项,以便在 任何 文档打开时运行代码。 此功能具有 Office 应用程序范围。 Microsoft 365 管理员在 Microsoft 365 租户的管理员门户中安装加载项后,该加载项将在清单中配置该加载项以支持的 Office 应用程序中打开的每个 Office 文档上启动并运行代码。 有关详细信息,请参阅 使用事件激活加载项,尤其是有关 OnDocumentOpened 事件的信息。

默认情况下, 不 包含任何 加载项命令 的任务窗格加载项在安装后立即打开任务窗格。 但是,当加载项具有一个或多个加载项命令时,则通知用户有新的加载项,但加载项不会自动启动。 这一历史默认行为正在更改,因此在某些情况下会自动启动具有加载项命令的加载项。 此外,如果加载项具有多个任务窗格页面,则可以控制安装时是否启动加载项,如果是,则在任务窗格中打开哪个页面。

注意

  • 此功能仅适用于最终用户安装的加载项,不适用于集中部署的加载项。
  • 此功能不适用于内容加载项或邮件 (Outlook) 加载项。
  • 此功能仅适用于具有至少一个 “任务窗格命令”类型的加载项命令的加载项。

新行为

新行为如下所示:

  • 如果加载项只有一个 任务窗格命令,则将选中该加载项的功能区选项卡,并在安装时自动打开任务窗格。 无需进行任何配置。
  • 如果加载项具有多个任务窗格命令,并且其中一个命令配置为默认命令 (请参阅 配置默认任务窗格) , 则将选中该加载项的功能区选项卡,并在安装时自动打开默认任务窗格。
  • 如果加载项具有多个任务窗格命令,但没有一个配置为默认命令,则会在安装时自动选择加载项的功能区选项卡,并且在选项卡附近会出现一个标注,通知用户新加载项,但不会打开任何任务窗格。 这与历史默认行为相同。

注意

如果出于任何原因,用户在启动时无法手动选择启动任务窗格的加载项命令,例如将其 配置为 在启动时禁用,则无论配置如何,它都不会自动打开。

在清单中配置默认任务窗格

指定默认任务窗格的过程取决于加载项使用的清单类型。

若要指定默认任务窗格,请在数组中 "runtimes" 查找运行时对象,其 "code.page" 属性设置为要作为默认任务窗格的页面的 URL。 确保"actions"同一运行时对象中的数组至少具有一个值为 "openPage"的操作"type"。 将属性添加到 "view" 此操作对象并将其设置为 "Office.AutoShowTaskpaneWithDocument"。 您只能在一个操作对象上设置此值,并且它必须是类型的 "openPage"操作。 如果在多个操作上设置此值,则该值的第一次出现将被视为默认值,其他值将被忽略。

下面的示例显示了一个"Office.AutoShowTaskpaneWithDocument"设置为 的值。"view"

"runtimes": [
    {
        ...
        "code": {
            "page": "https://contoso.com/taskpane.html"
        },
        "actions": [
            {
                "id": "ShowTaskPane",
                "type": "openPage",
                "view": "Office.AutoShowTaskpaneWithDocument"
            }
        ]
    }
]

提示

如果希望每当用户重新打开文档时加载项都自动启动,你需要执行进一步的配置步骤。 有关何时使用此功能的详细信息和建议,请参阅 自动打开包含文档的任务窗格。

另请参阅