Action 元素

项目
10/23/2024

指定当用户选择按钮或菜单控件时要执行的操作。

仅在以下 VersionOverrides 架构中有效：

任务窗格 1.0
邮件 1.0
邮件 1.1

与以下要求集关联：

当父 <VersionOverrides> 类型为 Taskpane 1.0 时，AddinCommands 1.1。
当父 <VersionOverrides> 类型为 Mail 1.0 时邮箱 1.3。
当父 <VersionOverrides> 类型为 Mail 1.1 时邮箱 1.5。

属性

属性	必需	说明
xsi:type	是	要执行的操作类型

xsi:type

此属性指定当用户选择按钮时所执行的操作类型。它可以是下列值之一：

ExecuteFunction
ShowTaskpane

用户选择启动操作的 ExecuteFunction 按钮后，如果当时尚未完成，外接程序将在 5 分钟后超时。

重要

Outlook：当 xsi：type 为 ExecuteFunction时，注册邮箱和项目事件不可用。

子元素

有效的子元素非常取决于参数的值 xsi:type 。

xsi：type 为 ExecuteFunction

元素	说明
FunctionName	指定要执行的函数的名称。

FunctionName

xsi：type 为 ExecuteFunction时所需的元素。指定要执行的函数的名称。函数包含在 FunctionFile 元素指定的文件中。

<Action xsi:type="ExecuteFunction">
  <FunctionName>getSubject</FunctionName>
</Action>

xsi：type 为 ShowTaskpane

元素	说明
SourceLocation	指定该操作的源文件位置。
TaskpaneId	指定任务窗格容器的 ID。 Outlook 加载项不支持。
标题	指定任务窗格的自定义标题。 Outlook 加载项不支持。
SupportsPinning	指定任务窗格支持固定，即使用户选择其他对象，任务窗格也可以继续处于打开状态。仅在 Outlook 中受支持。
SupportsMultiselect	指定 Outlook 加载项可以在多个所选邮件上激活。仅在 Outlook 中受支持。
SupportsNoItemContext	指定 Outlook 加载项可以在不启用阅读窗格或未选择邮件的情况下激活。仅在 Outlook 桌面客户端中受支持。

SourceLocation

xsi：type 为 ShowTaskpane时所需的元素。指定该操作的源文件位置。 resid 属性不能超过 32 个字符，并且必须设置为 Resources 元素中 Urls> 元素的<id 属性<的值。>

<Action xsi:type="ShowTaskpane">
  <SourceLocation resid="readTaskPaneUrl" />
</Action>

TaskpaneId

xsi：type 为 ShowTaskpane时的可选元素。指定任务窗格容器的 ID。如果有多个 ShowTaskpane 操作，请使用不同的 <TaskpaneId> （如果希望每个操作具有独立的窗格）。对共享同一 <窗格的不同操作使用相同的 TaskpaneId> 。当用户选择共享同一 <TaskpaneId> 的命令时，窗格容器将保持打开状态，但窗格的内容将替换为相应的操作 SourceLocation。

外接程序类型： 任务窗格

仅在以下 VersionOverrides 架构中有效：

任务窗格 1.0

有关详细信息，请参阅仅外接程序清单中的版本替代。

与以下要求集关联：

AddinCommands 1.1

注意

Outlook 不支持此元素。

以下示例显示了两个共享同一 <TaskpaneId 的操作>。

<Action xsi:type="ShowTaskpane">
  <TaskpaneId>MyPane</TaskpaneId>
  <SourceLocation resid="aTaskPaneUrl" />
</Action>

<Action xsi:type="ShowTaskpane">
  <TaskpaneId>MyPane</TaskpaneId>
  <SourceLocation resid="anotherTaskPaneUrl" />
</Action>

以下示例显示了两个 <使用不同的 TaskpaneId> 的操作。若要在上下文中查看这些示例，请参阅简单外接程序命令示例。

<Action xsi:type="ShowTaskpane">
   <TaskpaneId>MyTaskPaneID1</TaskpaneId>
   <SourceLocation resid="Contoso.Taskpane1.Url" />
</Action>

<Action xsi:type="ShowTaskpane">
   <TaskpaneId>MyTaskPaneID2</TaskpaneId>
   <SourceLocation resid="Contoso.Taskpane2.Url" />
</Action>

<bt:Urls>
   <bt:Url id="Contoso.Taskpane1.Url" DefaultValue="https://commandsimple.azurewebsites.net/Taskpane.html" />
   <bt:Url id="Contoso.Taskpane2.Url" DefaultValue="https://commandsimple.azurewebsites.net/Taskpane2.html" />
</bt:Urls>

标题

xsi：type 为 ShowTaskpane时的可选元素。指定此操作任务窗格的自定义标题。

外接程序类型： 任务窗格

仅在以下 VersionOverrides 架构中有效：

任务窗格 1.0

有关详细信息，请参阅仅外接程序清单中的版本替代。

与以下要求集关联：

AddinCommands 1.1

注意

Outlook 加载项不支持此子元素。

以下示例演示使用 <Title> 元素的操作。请注意，不直接将 <Title> 分配给字符串。相反，可以为其分配资源 ID (驻留) ，该 ID 在清单的 <“资源> ”部分中定义，且不能超过 32 个字符。

<Action xsi:type="ShowTaskpane">
    <TaskpaneId>Office.AutoShowTaskpaneWithDocument</TaskpaneId>
    <SourceLocation resid="PG.Code.Url" />
    <Title resid="PG.CodeCommand.Title" />
</Action>

 ... Other markup omitted ...
<Resources>
    <bt:Images> ...
    </bt:Images>
    <bt:Urls>
        <bt:Url id="PG.Code.Url" DefaultValue="https://localhost:3000?commands=1" />
    </bt:Urls>
    <bt:ShortStrings>
        <bt:String id="PG.CodeCommand.Title" DefaultValue="Code" />
    </bt:ShortStrings>
 ... Other markup omitted ...
</Resources>

SupportsPinning

xsi：type 为 ShowTaskpane时的可选元素。包含 VersionOverrides 元素的 xsi：type 属性值 VersionOverridesV1_1必须为。添加此元素时将值设为 true 可以支持任务窗格固定。这样一来，用户可以“固定”任务窗格，即使用户选择其他对象，任务窗格也可以继续处于打开状态。有关详细信息，请参阅在 Outlook 中实现可固定的任务窗格。

外接程序类型： 邮件

仅在以下 VersionOverrides 架构中有效：

邮件 1.1

有关详细信息，请参阅仅外接程序清单中的版本替代。

与以下要求集关联：

Mailbox 1.5

重要

尽管 SupportsPinning 元素是在要求集 1.5 中引入的，但目前仅支持使用以下Microsoft 365 订阅者：

新式 Outlook 网页版
新的 Outlook on Windows
Windows (版本 1612 (内部版本 7628.1000) 或更高版本Outlook 2016或更高版本)
Outlook on Mac (版本 16.13 (18050300) 或更高版本)

<Action xsi:type="ShowTaskpane">
  <SourceLocation resid="readTaskPaneUrl" />
  <SupportsPinning>true</SupportsPinning>
</Action>

SupportsMultiselect

当 xsi：type 为 ShowTaskpane时，Outlook 外接程序中的可选元素。包含一个值 true ，以允许加载项激活多个所选邮件并对其执行特定操作。由于项多选仅适用于消息，因此 ExtensionPoint 元素的 xsi：type 属性值必须设置为 MessageReadCommandSurface 或 MessageComposeCommandSurface。若要了解有关项目多选的详细信息，请参阅在多条消息上激活 Outlook 加载项。

外接程序类型： 邮件

仅在以下 VersionOverrides 架构中有效：

邮件 1.1

有关详细信息，请参阅仅外接程序清单中的版本替代。

与以下要求集关联：

邮箱 1.13

<Action xsi:type="ShowTaskpane">
    <SourceLocation resid="readTaskpaneUrl" />
    <SupportsMultiSelect>true</SupportsMultiSelect>
</Action>

SupportsNoItemContext

当 xsi：type 为 ShowTaskpane时，Outlook 外接程序中的可选元素。包含一个值 true ，以允许加载项在未启用阅读窗格或未选择邮件的情况下激活。如果 <SupportsNoItemContext> 设置为 true，则必须将 ExtensionPoint 元素的 xsi：type 属性值设置为 MessageReadCommandSurface。若要了解详细信息，请参阅在未启用阅读窗格或未选择邮件的情况下激活 Outlook 加载项。

外接程序类型： 邮件

仅在以下 VersionOverrides 架构中有效：

邮件 1.1

有关详细信息，请参阅仅外接程序清单中的版本替代。

与以下要求集关联：

邮箱 1.13

注意

尽管Outlook 网页版和新的 Outlook on Windows 支持邮箱要求集 1.13，但如果隐藏阅读窗格或未首先选择邮件，则不会激活加载项。若要了解详细信息，请参阅 Outlook 网页版和新的 Windows 版 Outlook 中的功能支持。

<Action xsi:type="ShowTaskpane">
    <SourceLocation resid="Taskpane.Url"/>
    <SupportsNoItemContext>true</SupportsNoItemContext>
</Action>

通过

Action 元素

属性

xsi:type

子元素

xsi：type 为 ExecuteFunction

FunctionName

xsi：type 为 ShowTaskpane

SourceLocation

TaskpaneId

标题

SupportsPinning

SupportsMultiselect

SupportsNoItemContext

其他资源