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

示例

以下示例创建一个新按钮，设置该按钮的各种属性，然后将该按钮添加到菜单中。 若要运行此代码示例，必须先执行以下步骤：

1. 将功能区 (Visual Designer) 项添加到使用 Visual Studio 中的 Office 开发工具创建的项目中。

2. 将组添加到自定义选项卡。

3. 将菜单添加到组。

4. 将菜单的 Dynamic 属性设置为 true。

5. 将菜单的 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

注解

将按钮控件从“工具箱”的“Office 功能区控件”选项卡拖动到功能区Designer时，Visual Studio 将创建实现 RibbonButton 接口的类的实例。

还可以在运行时创建此控件的实例，并将其添加到动态菜单中。 如果将菜单的 属性设置为 true，则菜单是动态的Dynamic。

只能在将功能区加载到 Office 应用程序之前或在运行时将控件添加到动态菜单之前设置此控件的某些属性。 有关设置这些属性的信息，请参阅 功能区对象模型概述。

可以在运行时使用 CreateRibbonButton 对象的 方法RibbonFactory创建 RibbonButton 。

可通过两种方法来访问 RibbonFactory 对象：

• 通过使用 Ribbon 类的 Factory 属性。 可从 Ribbon 类中的代码使用此方法。

• 通过使用 Globals.Factory.GetRibbonFactory 方法。 可从 Ribbon 类外的代码使用此方法。

常见任务

下表列出了对常见任务有用的成员。

任务	成员
在运行时，将按钮添加到其 Dynamic 属性设置为 true 的菜单中。	使用 创建实现 RibbonButton 接口的类的实例 CreateRibbonButton 类的 RibbonFactory 方法。 有关详细信息，请参阅 对 Office 项目中对象的全局访问。 将 实例添加到菜单的 Items 集合中。
更改按钮的大小。	将 设置为 ControlSize 所需的值。 例如，对于大按钮，请将其设置为 Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge。
在按钮上显示图像。	可通过三种方式显示图像： - 使用 Image 属性。 此属性提供最多的控件。 - 设置为 OfficeImageId 要显示为按钮图标的内置 Microsoft Office 图像的 ID。 - 将 ImageName 属性与 事件一起使用 LoadImage 。 此属性具有一些性能优势。
禁用或隐藏按钮。	若要禁用按钮，请将 设置为 Enabledfalse。 若要隐藏按钮，请将 设置为 Visiblefalse。
当用户单击按钮时运行代码。	将代码添加到 Click 事件处理程序。

注意

此接口由 Visual Studio Tools for Office Runtime 实现。 不应在代码中实现此接口。 有关更多信息，请参见 Visual Studio Tools for Office Runtime Overview。

使用情况

本文档介绍面向 .NET Framework 4 或更高版本的 Office 项目中所用的此类型的版本。 在面向 .NET Framework 3.5 的项目中，此类型可能具有不同的成员，因此本文档为此类型提供的代码示例可能并不适用。 有关在面向 .NET Framework 3.5 的项目中使用此类型的文档，请参阅 Visual Studio 2008 文档中的以下参考部分：http://go.microsoft.com/fwlink/?LinkId=160658。

属性

ControlSize	获取或设置按钮的大小。
Description	获取或设置当菜单的 属性设置为 Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge 时 ItemSize ，此按钮上显示的文本。
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	获取 Microsoft Office 应用程序提供给功能区扩展性代码的 IRibbonUI 实例。 (继承自 RibbonComponent)
ScreenTip	获取或设置当用户将指针移到按钮上方时显示的工具提示文本。
ShowImage	获取或设置一个值，该值指示与按钮关联的图像是否可见。
ShowLabel	获取或设置一个值，该值指示按钮的标签是否可见。
SuperTip	获取或设置当用户将指针移到按钮上方时显示的多行提示文本。
Tag	获取或设置与此 RibbonComponent 关联的应用程序特定的数据。 (继承自 RibbonComponent)
Visible	获取或设置一个值，该值指示此 RibbonControl 是否可见。 (继承自 RibbonControl)

方法

PerformDynamicLayout()	如果 RibbonComponent 具有一个动态父级（如动态菜单）且布局未挂起，则调用父控件的 Microsoft.Office.Core.IRibbonUI.InvalidateControl 方法。 (继承自 RibbonComponent)
PerformLayout()	如果 具有一个父级，且布局未挂起，则调用 RibbonComponentMicrosoft.Office.Core.IRibbonUI.InvalidateControl。 (继承自 RibbonComponent)
ResumeLayout()	取消 SuspendLayout() 方法的效果。 (继承自 RibbonComponent)
ResumeLayout(Boolean)	取消 SuspendLayout() 方法的效果。 (继承自 RibbonComponent)
SuspendLayout()	阻止 Microsoft Office 应用程序刷新功能区上的控件状态。 (继承自 RibbonComponent)

事件

Click

在用户单击按钮时发生。