RibbonButton - интерфейс

Статья
05/19/2013

Представляет кнопку на пользовательской ленте.

Пространство имен: Microsoft.Office.Tools.Ribbon
Сборка: Microsoft.Office.Tools.Common (в Microsoft.Office.Tools.Common.dll)

Синтаксис

'Декларация
<GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")> _
Public Interface RibbonButton _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

Тип RibbonButton предоставляет следующие члены.

Свойства

	Имя	Описание
	ControlSize	Возврат или установка размера кнопки.
	Description	Возврат или установка текста, который отображается на кнопке меню, если для свойства ItemSize меню установлено значение Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
	Enabled	Возврат или установка значения, указывающего, включен ли объект RibbonControl. (Унаследовано от RibbonControl.)
	Id	Получает уникальную строку, используемую в Microsoft Office для идентификации данного объекта RibbonControl. (Унаследовано от RibbonControl.)
	Image	Возврат или установка изображения, отображаемого на кнопке.
	ImageName	Возврат или установка имени, определяющего кнопку в обработчике событий LoadImage.
	KeyTip	Возврат или установка сочетания клавиш для кнопки.
	Label	Возврат или установка текста, отображаемого на кнопке.
	Name	Получает или задает имя данного объекта RibbonComponent. (Унаследовано от RibbonComponent.)
	OfficeImageId	Возврат или установка изображения, отображаемого на кнопке при использовании встроенного значка Microsoft Office.
	Parent	Возврат объекта RibbonComponent, который является родительским для этого объекта RibbonComponent. (Унаследовано от RibbonComponent.)
	Position	Возврат или установка положения кнопки в меню Microsoft Office.
	Ribbon	Возврат объекта верхнего уровня Ribbon, который содержит иерархию элементов управления. (Унаследовано от RibbonComponent.)
	RibbonUI	Инфраструктура. Получает экземпляр IRibbonUI, предоставляемый приложением Microsoft Office коду расширяемости ленты. (Унаследовано от RibbonComponent.)
	ScreenTip	Возврат или установка текста всплывающей подсказки, отображаемой при наведении указателя мыши на кнопку.
	ShowImage	Возврат или установка значения, которое определяет видимость изображения, связанного с кнопкой.
	ShowLabel	Возврат или установка значения, определяющего видимость метки кнопки.
	Site	Возвращает или задает объект ISite, связанный с объектом IComponent. (Унаследовано от IComponent.)
	SuperTip	Возврат или установка текста многострочной подсказки, отображаемой при наведении указателя мыши на кнопку.
	Tag	Возврат или установка данных приложения, связанных с этим объектом RibbonComponent. (Унаследовано от RibbonComponent.)
	Visible	Возврат или установка значения, определяющего видимость объекта RibbonControl. (Унаследовано от RibbonControl.)

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

Методы

	Имя	Описание
	Dispose	Выполняет определяемые приложением задачи, связанные с высвобождением или сбросом неуправляемых ресурсов. (Унаследовано от IDisposable.)
	PerformDynamicLayout	Вызов метода Microsoft.Office.Core.IRibbonUI.InvalidateControl родительского элемента управления, если для объекта RibbonComponent существует динамический родительский элемент, например динамическое меню, и размещение не приостановлено. (Унаследовано от RibbonComponent.)
	PerformLayout	Вызов метода Microsoft.Office.Core.IRibbonUI.InvalidateControl, если для объекта RibbonComponent существует родительский объект, и размещение не приостановлено. (Унаследовано от RibbonComponent.)
	ResumeLayout()	Отменяет результат вызова метода SuspendLayout. (Унаследовано от RibbonComponent.)
	ResumeLayout(Boolean)	Отменяет результат вызова метода SuspendLayout. (Унаследовано от RibbonComponent.)
	SuspendLayout	Запрет на обновление состояния элементов управления ленты в приложении Microsoft Office. (Унаследовано от RibbonComponent.)

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

События

	Имя	Описание
	Click	Вызывается при нажатии кнопки.
	Disposed	Представляет метод, обрабатывающий событие Disposed компонента. (Унаследовано от IComponent.)

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

Заметки

Visual Studio создает экземпляр класса, реализующего интерфейс RibbonButton при перетаскивании элемента управления Кнопка из вкладки Элементы управления ленты Office в конструктор ленты Панель инструментов.

Также можно создать экземпляр этого элемента управления во время выполнения и добавить его в динамическое меню.Динамическим называется меню, для свойства Dynamic которого установлено значение true.

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

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

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

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

Общие задачи

В следующей таблице перечислены члены, используемые при выполнении общих задач.

Задача	Элемент
Добавление кнопки в меню, свойству Dynamic которого присвоено значение true, во время выполнения.	Создайте экземпляр класса, который реализует интерфейс RibbonButton, используя CreateRibbonButton метод класса RibbonFactory.Для получения дополнительной информации см. Глобальный доступ к объектам в проектах Office. Добавьте созданный экземпляр в коллекцию Items меню.
Изменение размера кнопки.	Установите соответствующее значение свойства ControlSize.Например, для создания крупной кнопки установите значение Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Отображение изображения на кнопке.	Предусмотрено три способа отображения изображения: Используйте свойство Image.Это свойство обеспечивает максимальную степень управления. Присвойте свойству OfficeImageId значение идентификатора встроенного изображения Microsoft Office, которое необходимо использовать в качестве значка кнопки. Используйте свойство ImageName вместе с событием LoadImage.Это свойство обеспечивает некоторое повышение производительности.
Отключение или скрытие кнопок.	Чтобы отключить кнопку, установите для ее свойства Enabled значение false. Чтобы скрыть кнопку, установите для ее свойства Visible значение false.
Выполнение кода при нажатии кнопки.	Добавьте соответствующий код в обработчик событий Click.

Примечание
Данный интерфейс реализован набором средств 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.

Примеры

В следующем примере создается новая кнопка, устанавливаются ее различные свойства, после чего кнопка добавляется в меню.Перед выполнением этого примера выполните следующие действия:

Добавьте элемент Лента (визуальный конструктор) в проект, созданный с использованием средств разработки для Office в Visual Studio.
Добавьте группу на пользовательскую вкладку.
Добавьте меню в группу.
Установите для свойства Dynamic меню значение true.
Установите для свойства ItemSize меню значение RibbonControlSizeLarge.

Private Sub AddButtonsToMenu()
    Dim tempButton = Me.Factory.CreateRibbonButton()
    tempButton.Label = "Button 1"
    tempButton.ControlSize = _
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge
    tempButton.Description = "My Ribbon Button"
    tempButton.ShowImage = True
    tempButton.ShowImage = True
    tempButton.Image = My.Resources.Image1
    tempButton.Image = My.Resources.Image2
    tempButton.KeyTip = "A1"
    menu1.Items.Add(tempButton)
End Sub

private void AddButtonsToMenu()
{
    RibbonButton tempButton = this.Factory.CreateRibbonButton();
    tempButton.Label = "Button 1";
    tempButton.ControlSize =
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge;
    tempButton.Description = "My Ribbon Button";
    tempButton.ShowImage = true;
    tempButton.ShowImage = true;
    tempButton.Image = Properties.Resources.Image1;
    tempButton.Image = Properties.Resources.Image2;
    tempButton.KeyTip = "A1";
    menu1.Items.Add(tempButton);

}