按钮类型的控件元素

  • 项目

定义执行操作或启动任务窗格的按钮。

注意

本文假定熟悉基本 控件参考文章 ，其中包含有关元素属性的重要信息。

当用户选择某个按钮时，将执行一个操作。 它可以执行函数或显示任务窗格。 每个按钮控件必须具有在清单中的所有 <Control> 元素中唯一id的属性值。

重要

移动平台上忽略“按钮”类型控件。 若要支持移动平台，还必须对“Button”类型的每个控件都具有类型为“MobileButton”的控件。

子元素

元素 必需 说明
Label 是 按钮文本。
<提示> 否 按钮的工具提示。 resid 属性不能超过 32 个字符，并且必须设置为 String> 元素的<id 属性的值。 <String> 元素是 LongStrings> 元素的<子元素，它是 Resources 元素的子元素。
Supertip 是 按钮的 supertip。

重要提示：仅 Office 桌面客户端支持超级提示。
Icon 是 按钮的图像。
Action 是 指定要执行的操作。 Control 元素只能有一<个><Action 子元素。>
Enabled 否 指定在加载项启动时是否启用控件。
OverriddenByRibbonApi 否 指定是否应在支持自定义上下文选项卡的应用程序和平台组合上显示该按钮。 如果使用，它必须是 第一个 子元素。

标签

通过按钮的唯一属性来指定该按钮的文本，该属性不能超过 32 个字符，并且必须设置为 Resources元素的<>ShortStrings> 子元素的<id 属性的值。

加载项类型： 任务窗格，邮件

仅在以下 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。

示例

在以下示例中， 按钮执行函数。 它还配置为在加载项启动时禁用。 可以通过编程方式启用它。 有关详细信息，请参阅启用和禁用加载项命令。

<Control xsi:type="Button" id="Contoso.msgReadFunctionButton">
  <OverriddenByRibbonApi>true</OverriddenByRibbonApi>
  <Label resid="funcReadButtonLabel" />
  <Supertip>
    <Title resid="funcReadSuperTipTitle" />
    <Description resid="funcReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="blue-icon-16" />
    <bt:Image size="32" resid="blue-icon-32" />
    <bt:Image size="80" resid="blue-icon-80" />
  </Icon>
  <Action xsi:type="ExecuteFunction">
    <FunctionName>getSubject</FunctionName>
  </Action>
  <Enabled>false</Enabled>
</Control>

在以下示例中，按钮显示任务窗格。

<Control xsi:type="Button" id="Contoso.msgReadOpenPaneButton">
  <Label resid="paneReadButtonLabel" />
  <Supertip>
    <Title resid="paneReadSuperTipTitle" />
    <Description resid="paneReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="green-icon-16" />
    <bt:Image size="32" resid="green-icon-32" />
    <bt:Image size="80" resid="green-icon-80" />
  </Icon>
  <Action xsi:type="ShowTaskpane">
    <SourceLocation resid="readTaskPaneUrl" />
  </Action>
</Control>