RibbonButton Класс (2007 System)

Статья
11/16/2008

Обновлен: Ноябрь 2007

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

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

Синтаксис

'Декларация
<ToolboxBitmapAttribute(GetType(RibbonButton), "RibbonButton.bmp")> _
Public NotInheritable Class RibbonButton _
    Inherits RibbonControl
'Применение
Dim instance As RibbonButton

[ToolboxBitmapAttribute(typeof(RibbonButton), "RibbonButton.bmp")]
public sealed class RibbonButton : RibbonControl

Заметки

При перетаскивании элемента управления Button с вкладки Элементы управления ленты Officeпанели элементов в конструктор лент Visual Studio Tools for Office автоматически создаст экземпляр класса RibbonButton.

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

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

Общие задачи

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

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

Примеры

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

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

Private Sub AddButtonsToMenu()
    Dim tempButton As New RibbonButton()
    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 = new RibbonButton();
    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);

}

Иерархия наследования

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.Office.Tools.Ribbon.RibbonComponent
        Microsoft.Office.Tools.Ribbon.RibbonControl
          Microsoft.Office.Tools.Ribbon.RibbonButton

Потокобезопасность

Любые открытые члены этого типа, объявленные как static (Shared в Visual Basic), являются потокобезопасными. Потокобезопасность членов экземпляров не гарантируется.