RibbonToggleButton Interface

Reference

Definition

Namespace:: Microsoft.Office.Tools.Ribbon

Assembly:: Microsoft.Office.Tools.Common.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a toggle button control on a Ribbon.

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

Attributes: GuidAttribute

Implements: RibbonComponent RibbonControl IComponent IDisposable

Remarks

A RibbonToggleButton can be used to show whether an item is selected.

You can create a RibbonToggleButton at run time by using the CreateRibbonToggleButton method of the RibbonFactory object.

There are two ways to access the RibbonFactory object:

By using the Factory property of the Ribbon class. Use this approach from code in your Ribbon class.
By using the Globals.Factory.GetRibbonFactory method. Use this approach from code outside your Ribbon class.

Note

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 or later. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: http://go.microsoft.com/fwlink/?LinkId=160658.

Properties

Checked	Gets or sets a value that indicates whether the toggle button is pressed or not pressed.
ControlSize	Gets or sets the size of the RibbonToggleButton control.
Description	Gets or sets the text that appears on this RibbonToggleButton control in a menu.
Enabled	Gets or sets a value that indicates whether this RibbonControl is enabled. (Inherited from RibbonControl)
Id	Gets a string that Microsoft Office uses to identify this RibbonControl object. (Inherited from RibbonControl)
Image	Gets or sets the image that is displayed on the control.
ImageName	Gets or sets the name that you can use in the LoadImage event handler to identify an image for the control.
KeyTip	Gets or sets the keyboard shortcut of the toggle button.
Label	Gets or sets the text on the toggle button.
Name	Gets or sets the name of this RibbonComponent. (Inherited from RibbonComponent)
OfficeImageId	Gets or sets the image to display on the RibbonToggleButton, if you want to use a built-in Microsoft Office icon.
Parent	Gets a RibbonComponent that represents the parent of this RibbonComponent. (Inherited from RibbonComponent)
Position	Gets or sets the position of the RibbonToggleButton, if the control is on the Microsoft Office Menu.
Ribbon	Gets the top-level Ribbon object that contains the control hierarchy. (Inherited from RibbonComponent)
RibbonUI	Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code. (Inherited from RibbonComponent)
ScreenTip	Gets or sets tip text that appears when the user moves the pointer over the toggle button.
ShowImage	Gets or sets a value that indicates whether the image that is associated with the RibbonToggleButton is visible.
ShowLabel	Gets or sets a value that indicates whether the label for the RibbonToggleButton is visible.
SuperTip	Gets or sets multiline tip text that appears when the user moves the pointer over the RibbonToggleButton control.
Tag	Gets or sets application-specific data that is associated with this RibbonComponent. (Inherited from RibbonComponent)
Visible	Gets or sets a value that indicates whether this RibbonControl is visible. (Inherited from RibbonControl)

Methods

PerformDynamicLayout()	Calls the Microsoft.Office.Core.IRibbonUI.InvalidateControl method of the parent control if the RibbonComponent has a dynamic parent, such as a dynamic menu, and layout is not suspended. (Inherited from RibbonComponent)
PerformLayout()	Calls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended. (Inherited from RibbonComponent)
ResumeLayout()	Reverses the effect of the SuspendLayout() method. (Inherited from RibbonComponent)
ResumeLayout(Boolean)	Reverses the effect of the SuspendLayout() method. (Inherited from RibbonComponent)
SuspendLayout()	Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon. (Inherited from RibbonComponent)

Events

Click

Occurs when the user clicks the RibbonToggleButton control.

Applies to

Share via