通过

Menu 类型的控件元素

菜单定义选项列表。 每个菜单项将执行函数或显示任务窗格。

注意

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

菜单控件定义：

  • 根级菜单控件。
  • 菜单项的列表。

与 PrimaryCommandSurface 扩展点一起使用时，根菜单项在功能区上显示为按钮。 选择按钮后，菜单将显示为下拉列表。 不支持子菜单。

与 ContextMenu 扩展点一起使用时，上下文菜单上会显示根菜单项。 选择根项后，菜单项将显示为子菜单。 任何项本身都不能是子菜单，因为仅支持一个级别的子菜单。

子元素

元素 必需 说明
Label 是 菜单的文本。
Supertip 是 此菜单的超级提示。

重要提示：仅 Office 桌面客户端支持超级提示。
Icon 是 菜单的图像。
<项目> 是 要显示在菜单中的项的集合。 包含每个项的 <Item> 元素。
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。

示例

在以下示例中，菜单包含两个项。 第一个显示任务窗格。 第二个执行函数。 当加载项在支持上下文选项卡的平台上运行时，菜单已配置为 不 可见。 有关详细信息，请参阅 在不支持自定义上下文选项卡时实现备用 UI 体验。

<Control xsi:type="Menu" id="Contoso.TestMenu2">
  <OverriddenByRibbonApi>true</OverriddenByRibbonApi>
  <Label resid="residLabel3" />
  <Supertip>
    <Title resid="residLabel" />
    <Description resid="residToolTip" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="icon1_32x32" />
    <bt:Image size="32" resid="icon1_32x32" />
    <bt:Image size="80" resid="icon1_32x32" />
  </Icon>
  <Items>
    <Item id="ShowMainTaskPane">
      <Label resid="residLabel3"/>
      <Supertip>
        <Title resid="residLabel" />
        <Description resid="residToolTip" />
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="icon1_32x32" />
        <bt:Image size="32" resid="icon1_32x32" />
        <bt:Image size="80" resid="icon1_32x32" />
      </Icon>
      <Action xsi:type="ShowTaskpane">
        <TaskpaneId>MyTaskPaneID1</TaskpaneId>
        <SourceLocation resid="residUnitConverterUrl" />
      </Action>
    </Item>
    <Item id="GetData">
      <Label resid="residLabel5"/>
      <Supertip>
        <Title resid="residLabel" />
        <Description resid="residToolTip" />
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="icon4_32x32" />
        <bt:Image size="32" resid="icon4_32x32" />
        <bt:Image size="80" resid="icon4_32x32" />
      </Icon>
      <Action xsi:type="ExecuteFunction">
        <FunctionName>getData</FunctionName>
      </Action>
    </Item>
  </Items>
</Control>

在以下示例中，菜单的第二项配置为在支持上下文选项卡的平台上运行时 不 可见。 有关详细信息，请参阅 在不支持自定义上下文选项卡时实现备用 UI 体验。

<Control xsi:type="Menu" id="Contoso.msgReadMenuButton">
  <Label resid="menuReadButtonLabel" />
  <Supertip>
    <Title resid="menuReadSuperTipTitle" />
    <Description resid="menuReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="red-icon-16" />
    <bt:Image size="32" resid="red-icon-32" />
    <bt:Image size="80" resid="red-icon-80" />
  </Icon>
  <Items>
    <Item id="ShowMainTaskPane">
      <Label resid="residLabel3"/>
      <Supertip>
        <Title resid="residLabel" />
        <Description resid="residToolTip" />
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="icon1_32x32" />
        <bt:Image size="32" resid="icon1_32x32" />
        <bt:Image size="80" resid="icon1_32x32" />
      </Icon>
      <Action xsi:type="ShowTaskpane">
        <TaskpaneId>MyTaskPaneID1</TaskpaneId>
        <SourceLocation resid="residUnitConverterUrl" />
      </Action>
    </Item>
    <Item id="msgReadMenuItem1">
      <OverriddenByRibbonApi>true</OverriddenByRibbonApi>
      <Label resid="menuItem1ReadLabel" />
      <Supertip>
        <Title resid="menuItem1ReadLabel" />
        <Description resid="menuItem1ReadTip" />
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="red-icon-16" />
        <bt:Image size="32" resid="red-icon-32" />
        <bt:Image size="80" resid="red-icon-80" />
      </Icon>
      <Action xsi:type="ExecuteFunction">
        <FunctionName>getItemClass</FunctionName>
      </Action>
    </Item>
  </Items>
</Control>