TXTextControl.Windows.Forms.Ribbon.RibbonToggleButton Class

The RibbonToggleButton class is a checkable button control which can be added to a RibbonGroup or to a RibbonMenuButton where it is stored as an item of the drop-down menu. The RibbonToggleButton class is inherited from the RibbonButton class. The following describes only the properties, methods and events defined through the RibbonToggleButton class.

Introduced: 24.0.

Syntax

[C#]
public class RibbonToggleButton : RibbonButton
[Visual Basic]
Public Class RibbonToggleButton
  Inherits RibbonButton

Constructors

Constructor Description
RibbonToggleButton Initializes a new instance of the RibbonToggleButton class.

Properties

Property Description
Checked Gets or set a value indicating whether this RibbonToggleButton is checked.
Description Gets or sets the description text that appears on this button in a RibbonMenuButton's drop down menu when the DisplayMode property of the button is set to IconTextRelation.LargeIconLabeled. (Inherited from Windows.Forms.Ribbon.RibbonButton.)
DisplayMode Sets the RibbonButton's superordinate display settings and gets its corresponding text icon relation rendering to the current group's width. (Inherited from Windows.Forms.Ribbon.RibbonButton.)
IsAddToQuickAccessToolbarEnabled Gets or sets value whether the RibbonButton can be added to the quick access toolbar. (Inherited from Windows.Forms.Ribbon.RibbonButton.)
KeyTip Gets or sets the keyboard shortcut of the RibbonButton. (Inherited from Windows.Forms.Ribbon.RibbonButton.)
LargeIcon Gets or sets a 32x32 icon for this RibbonButton. (Inherited from Windows.Forms.Ribbon.RibbonButton.)
ParentCollection Gets the RibbonItemCollection that contains this RibbonButton. (Inherited from Windows.Forms.Ribbon.RibbonButton.)
SmallIcon Gets or sets a 16x16 icon for this RibbonButton. (Inherited from Windows.Forms.Ribbon.RibbonButton.)
Text Overridden. Gets or sets the RibbonButton's text. (Inherited from Windows.Forms.Ribbon.RibbonButton.)
ToolTip Gets an object of type RibbonToolTip that displays text when the mouse pointer hovers over the item. (Inherited from Windows.Forms.Ribbon.RibbonButton.)

Events

Event Description
CheckedChanged Occurs when the value of the Checked property changes.

See Also