RibbonDialogLauncher - интерфейс

Статья
05/19/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	Возврат объекта RibbonGroup, членом которого является объект RibbonDialogLauncher.
	Ribbon	Возврат объекта OfficeRibbon, на котором размещается объект RibbonDialogLauncher.
	ScreenTip	Возврат или установка текста подсказки, отображаемой при наведении указателя мыши на объект RibbonDialogLauncher.
	SuperTip	Возврат или установка текста многострочной подсказки, отображаемой при наведении указателя мыши на объект RibbonDialogLauncher.
	Visible	Возврат или установка значения, определяющего видимость объекта RibbonDialogLauncher.

В начало страницы

Методы

	Имя	Описание
	Dispose	Выполняет определяемые приложением задачи, связанные с высвобождением или сбросом неуправляемых ресурсов. (Унаследовано от IDisposable.)
	ResumeLayout	Отмена результатов вызова метода SuspendLayout.
	SuspendLayout	Запрет на обновление состояния элементов управления, расположенных на объекте OfficeRibbon приложения Microsoft Office.

В начало страницы

Заметки

Объект RibbonDialogLauncher по умолчанию отображается в левом нижнем углу группы.

Свойства Image, ImageName и OfficeImageId не имеют видимого действия, если на группе ленты отображается объект RibbonDialogLauncher.Однако при добавлении объекта RibbonDialogLauncher на панель быстрого доступа эти свойства определяют поведение отображаемого изображения.Также свойство Visible не может использоваться для скрытия объекта RibbonDialogLauncher, отображаемого в панели быстрого доступа.Пользователь можно добавить объект RibbonDialogLauncher на панель быстрого доступа с помощью пункта меню Лента (XML).Дополнительные сведения см. в разделе Обзор ленты.

Объект RibbonDialogLauncher применяется только к объекту RibbonGroup.Объект RibbonGroup имеет элемент DialogLauncher с типом RibbonDialogLauncher.Дополнительные сведения о добавлении объекта RibbonDialogLauncher к объекту RibbonGroup см. в разделе Практическое руководство. Добавление кнопки запуска диалогового окна в группу ленты.

Можно создать RibbonDialogLauncher во время выполнения, используя метод CreateRibbonDialogLauncher объекта RibbonFactory.

Существует два способа доступа к объекту RibbonFactory:

С помощью свойства Factory класса ленты.Этот подход следует применять в коде класса ленты.
С помощью метода Globals.Factory.GetRibbonFactory.Этот подход следует применять за пределами класса ленты.

Некоторые свойства этого элемента управления можно установить только перед загрузкой ленты в приложение Office.Дополнительные сведения об установке этих свойств см. в разделе Общие сведения об объектной модели ленты.

Примечание
Данный интерфейс реализован набором средств Visual Studio Tools for Office (среда выполнения). Он не предназначен для реализации в пользовательском коде. Дополнительные сведения см. в разделе Общие сведения об инструментах Visual Studio для среды выполнения Office.

Данный интерфейс реализован набором средств Visual Studio Tools for Office (среда выполнения). Он не предназначен для реализации в пользовательском коде. Дополнительные сведения см. в разделе Общие сведения об инструментах Visual Studio для среды выполнения Office.

Использование

В настоящей документации описывается версия этого типа, которая используется в проектах Office, предназначенных для платформ .NET Framework 4 и .NET Framework 4.5. В проектах, предназначенных для платформы .NET Framework 3.5, этот тип может содержать другие члены, а примеры кода, приведенные для этого типа, могут не работать. Документацию о данном типе в проектах, предназначенных для платформы .NET Framework 3.5, см. в следующем справочном разделе документации Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

Примеры

В следующем примере демонстрируется добавление объекта RibbonDialogLauncher в группу ленты и открытие пользовательского диалогового окна, которое позволяет выбрать дополнительные параметры. Диалоговое окно открывается по щелчку значка RibbonDialogLauncher, находящегося в нижнем правом углу группы ленты RibbonGroup.

Перед выполнением этого примера выполните следующие действия:

Добавьте элемент Лента (визуальный конструктор) в проект Office.
Добавьте элемент RibbonDialogLauncher в группу по умолчанию Group1 как описано в разделе Практическое руководство. Добавление кнопки запуска диалогового окна в группу ленты.
В проекте Visual Basic добавьте в проект новый элемент Диалоговое окно.В проекте C# добавьте элемент форма Windows Forms и превратите его в диалоговое окно, добавив на форму кнопки ОК и Отмена и создав обработчики событий нажатия кнопок.
Установите для свойства (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();
}