Action 元素

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

仅在以下 VersionOverrides 架构中有效:

  • 任务窗格 1.0
  • 邮件 1.0
  • 邮件 1.1

有关详细信息,请参阅仅加载 项清单中的版本替代。

与以下要求集关联:

  • 当父 <VersionOverrides> 类型为 Taskpane 1.0 时,为 AddinCommands 1.1。
  • 邮箱 1.3(如果父 <VersionOverrides> 类型为 Mail 1.0)。
  • 邮箱 1.5(如果父 <VersionOverrides> 类型为 Mail 1.1)。

属性

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

xsi:type

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

  • ExecuteFunction
  • ShowTaskpane

用户选择开始操作的 ExecuteFunction 按钮后,如果加载项尚未完成,则会在 5 分钟后超时。

重要

Outlook:当 MailboxItemxsi:type 为 ExecuteFunction.

子元素

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

xsi:type 是 ExecuteFunction

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

FunctionName

xsi:type 是ExecuteFunction时必需的元素。 指定要运行的函数的名称。 函数包含在 FunctionFile 元素指定的文件中。 在 FunctionName> 元素中<指定的值必须与传递到包含函数的文件中 Office.actions.associate 调用参数的actionId值匹配。 这可确保在选择按钮或菜单项控件时调用正确的函数。 若要了解详细信息,请参阅 使用仅加载项清单创建加载项命令。

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

xsi:type 是 ShowTaskpane

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

SourceLocation

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

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

TaskpaneId

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

外接程序类型: 任务窗格

仅在以下 VersionOverrides 架构中有效:

  • 任务窗格 1.0

有关详细信息,请参阅仅加载 项清单中的版本替代。

与以下要求集关联:

注意

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://localhost:3000/Taskpane.html" />
  <bt:Url id="Contoso.Taskpane2.Url" DefaultValue="https://localhost:3000/Taskpane2.html" />
</bt:Urls>

标题

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

外接程序类型: 任务窗格

仅在以下 VersionOverrides 架构中有效:

  • 任务窗格 1.0

有关详细信息,请参阅仅加载 项清单中的版本替代。

与以下要求集关联:

注意

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

以下示例演示使用 Title> 元素的<操作。 请注意,不会直接将 Title> 分配给<字符串。 相反,您可以为其分配资源 ID (resid) ,该 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

有关详细信息,请参阅仅加载 项清单中的版本替代。

与以下要求集关联:

重要

尽管在要求集 1.5 中引入了 SupportsPinning 元素,但目前仅 Microsoft 365 订阅者支持使用以下内容:

  • 新式 Outlook 网页版
  • Windows 版新 Outlook
  • Windows (版本 1612 (内部版本 7628.1000) 或更高版本上的 Outlook 2016 或更高版本)
  • Mac 上的 Outlook (版本 16.13 (18050300) 或更高版本)
<Action xsi:type="ShowTaskpane">
  <SourceLocation resid="readTaskPaneUrl" />
  <SupportsPinning>true</SupportsPinning>
</Action>

支持多选

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

外接程序类型: 邮件

仅在以下 VersionOverrides 架构中有效:

  • 邮件 1.1

有关详细信息,请参阅仅加载 项清单中的版本替代。

与以下要求集关联:

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

SupportsNoItemContext

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

外接程序类型: 邮件

仅在以下 VersionOverrides 架构中有效:

  • 邮件 1.1

有关详细信息,请参阅仅加载 项清单中的版本替代。

与以下要求集关联:

注意

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

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