按钮类型的控制元素

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

注意

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

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

重要

移动平台上将忽略“按钮”类型的控件。 若要支持移动平台,还必须为“Button”类型的每个控件设置一个类型为“MobileButton”的控件。

子元素

元素 必需 说明
Label 按钮文本。
Supertip 按钮的 supertip。

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

标签

通过其唯一属性 resid(最多可以超过 32 个字符)指定按钮的文本,并且必须设置为 Resources 元素的 ShortStrings> 子项中<String> 元素的<id 属性的值。

加载项类型: 任务窗格,“邮件”

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

示例

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

<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>