RibbonToggleButton 接口

定义

命名空间:

Microsoft.Office.Tools.Ribbon

程序集:

Microsoft.Office.Tools.Common.dll

表示功能区上的一个切换按钮控件。

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

[System.Runtime.InteropServices.Guid("fc50977f-187c-4082-ab53-087e81f4ded1")]
public interface RibbonToggleButton : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("fc50977f-187c-4082-ab53-087e81f4ded1")>]
type RibbonToggleButton = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonToggleButton
Implements IComponent, IDisposable, RibbonControl

属性

GuidAttribute

实现

RibbonComponent RibbonControl IComponent IDisposable

注解

RibbonToggleButton可用于显示是否选择了某个项。

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

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

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

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

注意

此接口由 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。

属性

Checked	获取或设置一个值，该值指示是否按下了切换按钮。
ControlSize	获取或设置 RibbonToggleButton 控件的大小。
Description	获取或设置菜单中此 RibbonToggleButton 控件上显示的文本。
Enabled	获取或设置一个值，该值指示是否启用此 RibbonControl。 (继承自 RibbonControl)
Id	获取一个字符串，Microsoft Office 将用其标识此 RibbonControl 对象。 (继承自 RibbonControl)
Image	获取或设置控件上显示的图像。
ImageName	获取或设置一个名称，该名称可用于在 LoadImage 事件处理程序中标识控件图像。
KeyTip	获取或设置切换按钮的键盘快捷键。
Label	获取或设置切换按钮上的文本。
Name	获取或设置此 RibbonComponent 的名称。 (继承自 RibbonComponent)
OfficeImageId	如果要使用内置 Microsoft Office 图标，请获取或设置要在 RibbonToggleButton 上显示的图像。
Parent	获取一个 RibbonComponent，表示此 RibbonComponent 的父级。 (继承自 RibbonComponent)
Position	如果控件位于 Microsoft Office 菜单上，请获取或设置 RibbonToggleButton 的位置。
Ribbon	获取包含控件层次结构的顶级 Ribbon 对象。 (继承自 RibbonComponent)
RibbonUI	获取 Microsoft Office 应用程序提供给功能区扩展性代码的 IRibbonUI 实例。 (继承自 RibbonComponent)
ScreenTip	获取或设置当用户将指针移到切换按钮上方时显示的提示文本。
ShowImage	获取或设置一个值，该值指示与 RibbonToggleButton 关联的图像是否可见。
ShowLabel	获取或设置一个值，该值指示 RibbonToggleButton 的标签是否可见。
SuperTip	获取或设置用户将指针移到 RibbonToggleButton 控件上方时显示的多行提示文本。
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

当用户单击 RibbonToggleButton 控件时发生。