通过

RibbonGallery 接口

  • 项目

表示一个控件，该控件显示 RibbonDropDownItem 对象和 RibbonButton 控件的菜单。

命名空间：  Microsoft.Office.Tools.Ribbon
程序集：  Microsoft.Office.Tools.Common（在 Microsoft.Office.Tools.Common.dll 中）

语法

声明
<GuidAttribute("c1cff037-81e7-44a0-8f9d-150237dfd312")> _
Public Interface RibbonGallery _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("c1cff037-81e7-44a0-8f9d-150237dfd312")]
public interface RibbonGallery : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

RibbonGallery 类型公开以下成员。

属性

  名称 说明
公共属性 Buttons 获取此 RibbonGallery 上的按钮的集合。
公共属性 ColumnCount 获取或设置此 RibbonGallery 中的 Item 列的数目。
公共属性 ControlSize 获取或设置 RibbonGallery 控件的大小。
公共属性 Description 获取或设置在菜单或拆分按钮中的此 RibbonGallery 控件上显示的文本。
公共属性 Enabled 获取或设置一个值，该值指示是否启用此 RibbonControl。 （继承自 RibbonControl。）
公共属性 Id 获取一个字符串，Microsoft Office 使用它来标识此 RibbonControl 对象。 （继承自 RibbonControl。）
公共属性 Image 获取或设置在按钮上显示的图像。
公共属性 ImageName 获取或设置一个名称，您可以在 LoadImage 事件处理程序中使用该名称标识 RibbonGallery。
公共属性 ItemImageSize 获取或设置一个 Size，它给出此 RibbonGallery 中的项所显示的图像的尺寸。
公共属性 Items 获取此 RibbonGallery 中的 RibbonDropDownItem 组件的集合。
公共属性 KeyTip 获取或设置此 RibbonGallery 的键盘快捷键。
公共属性 Label 获取或设置在此 RibbonGallery 上显示的文本。
公共属性 Name 获取或设置此 RibbonComponent 的名称。 （继承自 RibbonComponent。）
公共属性 OfficeImageId 获取或设置该控件上显示的图像（如果要使用内置 Microsoft Office 图标）。
公共属性 Parent 获取一个表示此 RibbonComponent 的父级的 RibbonComponent。 （继承自 RibbonComponent。）
公共属性 Position 获取或设置库的位置（如果库在 Microsoft Office 菜单上）。
公共属性 Ribbon 获取包含控件层次结构的顶级 Ribbon 对象。 （继承自 RibbonComponent。）
公共属性 RibbonUI 基础结构。获取 Microsoft Office 应用程序提供给功能区扩展性代码的 IRibbonUI 实例。 （继承自 RibbonComponent。）
公共属性 RowCount 获取或设置此 RibbonGallery 显示的 RibbonDropDownItem 组件的行数。
公共属性 ScreenTip 获取或设置当用户将指针移到此 RibbonGallery 上时显示的提示文本。
公共属性 SelectedItem 获取或设置当前选定的项。
公共属性 SelectedItemIndex 获取或设置当前选定的 RibbonDropDownItem 的索引。
公共属性 ShowImage 获取或设置一个值，该值指示与 RibbonGallery 关联的图像是否可见。
公共属性 ShowItemImage 获取或设置一个值，该值指示是否为库中的项显示图像。
公共属性 ShowItemLabel 获取或设置一个值，该值指示是否为此 RibbonGallery 中的项显示标签。
公共属性 ShowItemSelection 获取或设置一个值，该值指示当前所选的 RibbonDropDownItem 在外观上是否与其余未选择的项有所区别。
公共属性 ShowLabel 获取或设置一个值，该值指示此 RibbonGallery 的标签是否可见。
公共属性 Site 获取或设置与 IComponent 关联的 ISite。 （继承自 IComponent。）
公共属性 SuperTip 获取或设置当用户将指针移到 RibbonGallery 上时显示的多行提示文本。
公共属性 Tag 获取或设置与此 RibbonComponent 关联的特定于应用程序的数据。 （继承自 RibbonComponent。）
公共属性 Visible 获取或设置一个值，该值指示此 RibbonControl 是否可见。 （继承自 RibbonControl。）

页首

方法

  名称 说明
公共方法 Dispose 执行与释放或重置非托管资源相关的应用程序定义的任务。 （继承自 IDisposable。）
公共方法 PerformDynamicLayout 如果 RibbonComponent 有一个动态父级（如动态菜单）且布局未挂起，则调用父控件的 Microsoft.Office.Core.IRibbonUI.InvalidateControl 方法。 （继承自 RibbonComponent。）
公共方法 PerformLayout 如果 RibbonComponent 有父级，并且布局未挂起，则调用 Microsoft.Office.Core.IRibbonUI.InvalidateControl。 （继承自 RibbonComponent。）
公共方法 ResumeLayout() 取消 SuspendLayout 方法的效果。 （继承自 RibbonComponent。）
公共方法 ResumeLayout(Boolean) 取消 SuspendLayout 方法的效果。 （继承自 RibbonComponent。）
公共方法 SuspendLayout 阻止 Microsoft Office 应用程序刷新功能区上的控件的状态。 （继承自 RibbonComponent。）

页首

事件

  名称 说明
公共事件 ButtonClick 当用户单击此 RibbonGallery 上的按钮时发生。
公共事件 Click 当用户单击此 RibbonGallery 上的项时发生。
公共事件 Disposed 表示处理组件的 Disposed 事件的方法。 （继承自 IComponent。）
公共事件 ItemsLoading 在打开此 RibbonGallery 时发生。

页首

备注

与 RibbonDropDown 接口一样，RibbonGallery 显示 RibbonDropDownItem 对象和 RibbonButton 控件的菜单。

与 RibbonDropDown 接口不同，当用户单击 RibbonDropDownItem 时，RibbonGallery 接口引发 Click 事件，而非 SelectionChanged 事件。这意味着当用户单击同一 RibbonDropDownItem 两次时，Click 事件将引发两次。（对已做出过初始选择的 RibbonDropDown 执行上述相同操作时，根据第一次单击之前选择的内容，将最多引发一次 SelectionChanged 事件。）

ShowItemSelection 属性控制当前所选的 RibbonDropDownItem 在外观上是否与未选择的项有所区别。在 RibbonGallery 中一次只能选择一项。

ItemImageSize 属性可用于指定 16x16 和 32x32 以外的图像尺寸。

在设计时添加 RibbonDropDownItem 对象

  1. 单击**“属性”窗口中的“Items”**属性。

  2. 单击省略号（“...”）。

  3. 在**“DropDown 集合编辑器”**中添加新项并对其进行排序和编辑。

可以在设计时将 RibbonButton 控件添加到 RibbonGallery。

在设计时添加 RibbonButton 控件

  1. 单击**“属性”窗口中的“Buttons”**属性。

  2. 单击省略号（“...”）。

  3. 在**“按钮集合编辑器”**中添加新按钮控件并对其进行排序和编辑。

在运行时，可以使用 RibbonFactory 对象的 CreateRibbonGallery 方法创建 RibbonGallery。

有两种方法可访问 RibbonFactory 对象：

  • 使用功能区类的 Factory 属性。请通过功能区类中的代码使用此方法。

  • 使用 Globals.Factory.GetRibbonFactory 方法。请通过功能区类之外的代码使用此方法。

此控件的某些属性只能在运行时设置，并且只能在功能区加载到 Office 应用程序之前，或者该控件添加到动态菜单之前进行设置。有关如何设置这些属性的信息，请参见功能区对象模型概述。

说明说明

此接口由 Visual Studio Tools for Office Runtime 实现。不应在代码中实现此接口。有关更多信息，请参见 Visual Studio Tools for Office Runtime 概述。

用法

本文档介绍面向 .NET Framework 4 和 .NET Framework 4.5 的 Office 项目中所用此类型的版本。在面向 .NET Framework 3.5 的项目中，此类型可能具有不同的成员，因此本文档为此类型提供的代码示例可能并不适用。有关面向 .NET Framework 3.5 的项目中的此类型的文档，请参见 Visual Studio 2008 文档中的以下参考部分：https://go.microsoft.com/fwlink/?LinkId=160658。

请参见

参考

Microsoft.Office.Tools.Ribbon 命名空间

其他资源

功能区概述

功能区设计器

功能区对象模型概述

如何：开始自定义功能区