RibbonButton Интерфейс

Ссылка

Определение

Пространство имен:: Microsoft.Office.Tools.Ribbon

Сборка:: Microsoft.Office.Tools.Common.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

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

public interface class RibbonButton : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonControl, System::ComponentModel::IComponent

[System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")>]
type RibbonButton = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonButton
Implements IComponent, IDisposable, RibbonControl

Атрибуты: GuidAttribute

Реализации: RibbonComponent RibbonControl IComponent IDisposable

Примеры

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

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

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);

}

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

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

Вы также можете создать экземпляр этого элемента управления во время выполнения и добавить его в динамическое меню. Меню является динамическим, если для его 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 Tools for Office Runtime Overview.

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

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

Свойства

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	Возвращает или задает значение, определяющее видимость метки кнопки.
SuperTip	Возвращает или задает текст многострочной подсказки, отображаемой при наведении указателя мыши на кнопку.
Tag	Получает или задает данные приложения, связанные с этим объектом RibbonComponent. (Унаследовано от RibbonComponent)
Visible	Получает или задает значение, указывающее, видим ли этот объект RibbonControl. (Унаследовано от RibbonControl)

Методы

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

Происходит при нажатии кнопки.

Применяется к

Поделиться через