RibbonToggleButton 接口
表示功能区上的一个切换按钮控件。
命名空间: Microsoft.Office.Tools.Ribbon
程序集: Microsoft.Office.Tools.Common(在 Microsoft.Office.Tools.Common.dll 中)
语法
声明
<GuidAttribute("fc50977f-187c-4082-ab53-087e81f4ded1")> _
Public Interface RibbonToggleButton _
Inherits RibbonControl, RibbonComponent, IComponent, IDisposable
[GuidAttribute("fc50977f-187c-4082-ab53-087e81f4ded1")]
public interface RibbonToggleButton : RibbonControl,
RibbonComponent, IComponent, IDisposable
RibbonToggleButton 类型公开以下成员。
属性
名称 | 说明 | |
---|---|---|
Checked | 获取或设置一个值,该值指示是否按下了切换按钮。 | |
ControlSize | 获取或设置 RibbonToggleButton 控件的大小。 | |
Description | 获取或设置在菜单中的此 RibbonToggleButton 控件上显示的文本。 | |
Enabled | 获取或设置一个值,该值指示是否启用此 RibbonControl。 (继承自 RibbonControl。) | |
Id | 获取一个字符串,Microsoft Office 使用它来标识此 RibbonControl 对象。 (继承自 RibbonControl。) | |
Image | 获取或设置控件上显示的图像。 | |
ImageName | 获取或设置一个名称,您可以在 LoadImage 事件处理程序中使用该名称标识控件的图像。 | |
KeyTip | 获取或设置切换按钮的键盘快捷键。 | |
Label | 获取或设置切换按钮上的文本。 | |
Name | 获取或设置此 RibbonComponent 的名称。 (继承自 RibbonComponent。) | |
OfficeImageId | 获取或设置 RibbonToggleButton 上显示的图像(如果要使用内置 Microsoft Office 图标)。 | |
Parent | 获取一个表示此 RibbonComponent 的父级的 RibbonComponent。 (继承自 RibbonComponent。) | |
Position | 获取或设置 RibbonToggleButton 的位置(如果该控件在 Microsoft Office 菜单上)。 | |
Ribbon | 获取包含控件层次结构的顶级 Ribbon 对象。 (继承自 RibbonComponent。) | |
RibbonUI | 基础结构。获取 Microsoft Office 应用程序提供给功能区扩展性代码的 IRibbonUI 实例。 (继承自 RibbonComponent。) | |
ScreenTip | 获取或设置当用户将指针移到切换按钮上时显示的提示文本。 | |
ShowImage | 获取或设置一个值,该值指示与 RibbonToggleButton 关联的图像是否可见。 | |
ShowLabel | 获取或设置一个值,该值指示 RibbonToggleButton 的标签是否可见。 | |
Site | 获取或设置与 IComponent 关联的 ISite。 (继承自 IComponent。) | |
SuperTip | 获取或设置当用户将指针移到 RibbonToggleButton 控件上时显示的多行提示文本。 | |
Tag | 获取或设置与此 RibbonComponent 关联的特定于应用程序的数据。 (继承自 RibbonComponent。) | |
Visible | 获取或设置一个值,该值指示此 RibbonControl 是否可见。 (继承自 RibbonControl。) |
页首
方法
名称 | 说明 | |
---|---|---|
Dispose | 执行与释放或重置非托管资源相关的应用程序定义的任务。 (继承自 IDisposable。) | |
PerformDynamicLayout | 如果 RibbonComponent 有一个动态父级(如动态菜单)且布局未挂起,则调用父控件的 Microsoft.Office.Core.IRibbonUI.InvalidateControl 方法。 (继承自 RibbonComponent。) | |
PerformLayout | 如果 RibbonComponent 有父级,并且布局未挂起,则调用 Microsoft.Office.Core.IRibbonUI.InvalidateControl。 (继承自 RibbonComponent。) | |
ResumeLayout() | 取消 SuspendLayout 方法的效果。 (继承自 RibbonComponent。) | |
ResumeLayout(Boolean) | 取消 SuspendLayout 方法的效果。 (继承自 RibbonComponent。) | |
SuspendLayout | 阻止 Microsoft Office 应用程序刷新功能区上的控件的状态。 (继承自 RibbonComponent。) |
页首
事件
名称 | 说明 | |
---|---|---|
Click | 当用户单击 RibbonToggleButton 控件时发生。 | |
Disposed | 表示处理组件的 Disposed 事件的方法。 (继承自 IComponent。) |
页首
备注
RibbonToggleButton 可用于显示是否选择了某项。
在运行时,可以使用 RibbonFactory 对象的 CreateRibbonToggleButton 方法创建 RibbonToggleButton。
有两种方法可访问 RibbonFactory 对象:
使用功能区类的 Factory 属性。 请通过功能区类中的代码使用此方法。
使用 Globals.Factory.GetRibbonFactory 方法。 请通过功能区类之外的代码使用此方法。
备注
此接口由 Visual Studio Tools for Office Runtime 实现。不应在代码中实现此接口。有关更多信息,请参见 Visual Studio Tools for Office Runtime 概述。
用法
本文档介绍面向 .NET Framework 4 和 .NET Framework 4.5 的 Office 项目中所用此类型的版本。在面向 .NET Framework 3.5 的项目中,此类型可能具有不同的成员,因此本文档为此类型提供的代码示例可能并不适用。有关面向 .NET Framework 3.5 的项目中的此类型的文档,请参见 Visual Studio 2008 文档中的以下参考部分:https://go.microsoft.com/fwlink/?LinkId=160658。
请参见
参考
Microsoft.Office.Tools.Ribbon 命名空间