RibbonToggleButton Interface

RibbonToggleButton Interface

 

Represents a toggle button control on a Ribbon.

Namespace:   Microsoft.Office.Tools.Ribbon
Assembly:  Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

[GuidAttribute("fc50977f-187c-4082-ab53-087e81f4ded1")]
public interface RibbonToggleButton : RibbonControl, RibbonComponent, 
	IComponent, IDisposable

NameDescription
System_CAPS_pubpropertyChecked

Gets or sets a value that indicates whether the toggle button is pressed or not pressed.

System_CAPS_pubpropertyControlSize

Gets or sets the size of the RibbonToggleButton control.

System_CAPS_pubpropertyDescription

Gets or sets the text that appears on this RibbonToggleButton control in a menu.

System_CAPS_pubpropertyEnabled

Gets or sets a value that indicates whether this RibbonControl is enabled.(Inherited from RibbonControl.)

System_CAPS_pubpropertyId

Gets a string that Microsoft Office uses to identify this RibbonControl object.(Inherited from RibbonControl.)

System_CAPS_pubpropertyImage

Gets or sets the image that is displayed on the control.

System_CAPS_pubpropertyImageName

Gets or sets the name that you can use in the LoadImage event handler to identify an image for the control.

System_CAPS_pubpropertyKeyTip

Gets or sets the keyboard shortcut of the toggle button.

System_CAPS_pubpropertyLabel

Gets or sets the text on the toggle button.

System_CAPS_pubpropertyName

Gets or sets the name of this RibbonComponent.(Inherited from RibbonComponent.)

System_CAPS_pubpropertyOfficeImageId

Gets or sets the image to display on the RibbonToggleButton, if you want to use a built-in Microsoft Office icon.

System_CAPS_pubpropertyParent

Gets a RibbonComponent that represents the parent of this RibbonComponent.(Inherited from RibbonComponent.)

System_CAPS_pubpropertyPosition

Gets or sets the position of the RibbonToggleButton, if the control is on the Microsoft Office Menu.

System_CAPS_pubpropertyRibbon

Gets the top-level Ribbon object that contains the control hierarchy.(Inherited from RibbonComponent.)

System_CAPS_pubpropertyRibbonUI

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code.(Inherited from RibbonComponent.)

System_CAPS_pubpropertyScreenTip

Gets or sets tip text that appears when the user moves the pointer over the toggle button.

System_CAPS_pubpropertyShowImage

Gets or sets a value that indicates whether the image that is associated with the RibbonToggleButton is visible.

System_CAPS_pubpropertyShowLabel

Gets or sets a value that indicates whether the label for the RibbonToggleButton is visible.

System_CAPS_pubpropertySite

(Inherited from IComponent.)

System_CAPS_pubpropertySuperTip

Gets or sets multiline tip text that appears when the user moves the pointer over the RibbonToggleButton control.

System_CAPS_pubpropertyTag

Gets or sets application-specific data that is associated with this RibbonComponent.(Inherited from RibbonComponent.)

System_CAPS_pubpropertyVisible

Gets or sets a value that indicates whether this RibbonControl is visible.(Inherited from RibbonControl.)

NameDescription
System_CAPS_pubmethodDispose()

(Inherited from IDisposable.)

System_CAPS_pubmethodPerformDynamicLayout()

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

System_CAPS_pubmethodPerformLayout()

Calls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended.(Inherited from RibbonComponent.)

System_CAPS_pubmethodResumeLayout()

Reverses the effect of the SuspendLayout method.(Inherited from RibbonComponent.)

System_CAPS_pubmethodResumeLayout(Boolean)

Reverses the effect of the SuspendLayout method.(Inherited from RibbonComponent.)

System_CAPS_pubmethodSuspendLayout()

Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon.(Inherited from RibbonComponent.)

NameDescription
System_CAPS_pubeventClick

Occurs when the user clicks the RibbonToggleButton control.

System_CAPS_pubeventDisposed

(Inherited from IComponent.)

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.

System_CAPS_noteNote

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.

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.

Return to top
Show:
© 2016 Microsoft