菜单定义选项列表。 每个菜单项将执行函数或显示任务窗格。
注意
本文假定您熟悉基本的 控件参考文章 ,其中包含有关元素属性的重要信息。
菜单控件定义:
- 根级菜单控件。
- 菜单项列表。
与 PrimaryCommandSurface 扩展点一起使用时,根菜单项将显示为功能区上的按钮。 选中该按钮后,菜单将显示为下拉列表。 不支持子菜单。
与 ContextMenu 扩展点一起使用时,根菜单项将显示在上下文菜单上。 选择根项后,菜单项将显示为子菜单。 任何项本身都不能是子菜单,因为只支持一个级别的子菜单。
子元素
| 元素 | 必需 | 说明 |
|---|---|---|
| Label | 是 | 菜单的文本。 |
| Supertip | 是 | 此菜单的超提示。 重要提示: 仅在 Office 桌面客户端中受支持超级提示。 |
| 图标 | 是 | 菜单的图像。 |
| <物品> | 是 | 要在菜单中显示的项目的集合。 包含每个物品的 <Item> 元素。 |
| OverriddenByRibbonApi | 否 | 指定菜单是否应显示在支持自定义上下文选项卡的应用程序和平台组合上。 如果使用,则必须是 第一个 子元素。 |
标签
通过其唯一属性 resid 指定菜单名称的文本,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)。
示例
在下面的示例中,菜单有两个项。 第一个显示任务窗格。 第二个执行函数。 该菜单已 配置为在 支持上下文选项卡的平台上运行时不可见。 有关详细信息,请参阅“在不 支持自定义上下文选项卡时实现备用 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>