RibbonDialogLauncher 接口

项目
05/20/2013

表示组中可用来打开对话框的标准化小图标。

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

语法

声明
<GuidAttribute("e143d5e9-e844-4052-9793-2070185d351d")> _
Public Interface RibbonDialogLauncher _
    Inherits IDisposable

[GuidAttribute("e143d5e9-e844-4052-9793-2070185d351d")]
public interface RibbonDialogLauncher : IDisposable

RibbonDialogLauncher 类型公开以下成员。

属性

	名称	说明
	Enabled	获取或设置一个值，该值指示是否启用此 RibbonDialogLauncher。
	Image	获取或设置一个图像，当此 RibbonDialogLauncher 添加到快速访问工具栏时，该图像将显示在其中。
	ImageName	获取或设置一个标识符，它用于在此 RibbonDialogLauncher 添加到快速访问工具栏时将图像分配给它。
	KeyTip	获取或设置此 RibbonDialogLauncher 的键盘快捷键。
	OfficeImageId	获取或设置在此 RibbonDialogLauncher 上显示的图像（如果要使用内置 Microsoft Office 图标）。
	Parent	获取此 RibbonDialogLauncher 所属的 RibbonGroup 对象。
	Ribbon	获取此 RibbonDialogLauncher 所在的 OfficeRibbon。
	ScreenTip	获取或设置当用户将指针移到此 RibbonDialogLauncher 上时显示的提示文本。
	SuperTip	获取或设置当用户将指针移到 RibbonDialogLauncher 上时显示的多行提示文本。
	Visible	获取或设置一个值，该值指示此 RibbonDialogLauncher 是否可见。

页首

方法

	名称	说明
	Dispose	执行与释放或重置非托管资源相关的应用程序定义的任务。（继承自 IDisposable。）
	ResumeLayout	取消 SuspendLayout 方法的效果。
	SuspendLayout	阻止 Microsoft Office 应用程序刷新 OfficeRibbon 中的控件的状态。

页首

备注

RibbonDialogLauncher 默认情况下显示在组的右下角。

当 RibbonDialogLauncher 在功能区上的组中显示时，Image、ImageName 和 OfficeImageId 属性没有任何可见效果。但是，当用户将 RibbonDialogLauncher 添加到快速访问工具栏时，这些属性将控制显示的图像的行为。而且，当 RibbonDialogLauncher 在快速访问工具栏上显示时，Visible 属性不会将其隐藏。用户可以通过**“功能区(XML)”**项将 RibbonDialogLauncher 添加到快速访问工具栏。有关更多信息，请参见功能区概述。

RibbonDialogLauncher 仅应用于 RibbonGroup。RibbonGroup 对象有一个 RibbonDialogLauncher 类型的 DialogLauncher 成员。有关如何将 RibbonDialogLauncher 添加到 RibbonGroup 的信息，请参见如何：向功能区组添加对话框启动器。

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

有两种方法可访问 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。

示例

下面的示例演示如何将一个 RibbonDialogLauncher 添加到功能区组，以及如何启动使得用户可以在单击 RibbonGroup 右下角的 RibbonDialogLauncher 图标时选择高级设置的自定义对话框。

若要运行此代码示例，必须先执行下列步骤：

将一个**“功能区(可视化设计器)”**项添加到 Office 项目中。
按照如何：向功能区组添加对话框启动器中所述，将一个 RibbonDialogLauncher 添加到默认组 Group1 中。
如果使用的是 Visual Basic，请将一个新的**“对话框”项添加到项目中。如果使用的是 C#，请添加一个新的“Windows 窗体”项，然后通过向窗体中添加“确定”和“取消”**按钮并为按钮的单击事件创建事件处理程序将其转换为对话框。
将该对话框的**“(Name)”**属性设置为 advancedSettingsDialog。可以通过添加控件和设置更多属性来自定义该对话框。
向代码中添加 DialogLauncherClick 事件处理程序。
将以下方法的内容放到 DialogLauncherClick 事件处理程序中。

Private Sub Group1_DialogLauncherClick(ByVal sender As Object, ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) Handles Group1.DialogLauncherClick
    Dim dlg As advancedSettingsDialog = New advancedSettingsDialog()
    dlg.ShowDialog()
End Sub

void group1_DialogLauncherClick(object sender, Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs e)
{
    advancedSettingsDialog dlg = new advancedSettingsDialog();
    dlg.ShowDialog();
}

请参见

参考

Microsoft.Office.Tools.Ribbon 命名空间

其他资源

如何：在 Office 项目中创建事件处理程序