TXTextControl.Windows.Forms.Ribbon.RibbonButton Class

The RibbonButton class is a 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. Furthermore it is the base class of the RibbonToggleButton and RibbonMenuButton classes. The RibbonButton class is inherited from the System.Windows.Forms.Control class and implements the System.ComponentModel.INotifyPropertyChanged interface. The following describes only the properties, methods and events defined through the RibbonButton class. For a list of properties, methods and events inherited from the System.Windows.Forms.Control class and the System.ComponentModel.INotifyPropertyChanged interface see the .NET Framework reference.

Introduced: 24.0.

Syntax

[C#]
public class RibbonButton : System.Windows.Forms.Control, System.ComponentModel.INotifyPropertyChanged
[Visual Basic]
Public Class RibbonButton
  Inherits System.Windows.Forms.Control
  Implements System.ComponentModel.INotifyPropertyChanged

Constructors

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

Properties

Property Description
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.
DisplayMode Sets the RibbonButton's superordinate display settings and gets its corresponding text icon relation rendering to the current group's width.
IsAddToQuickAccessToolbarEnabled Gets or sets value whether the RibbonButton can be added to the quick access toolbar.
KeyTip Gets or sets the keyboard shortcut of the RibbonButton.
LargeIcon Gets or sets a 32x32 icon for this RibbonButton.
ParentCollection Gets the RibbonItemCollection that contains this RibbonButton.
SmallIcon Gets or sets a 16x16 icon for this RibbonButton.
Text Overridden. Gets or sets the RibbonButton's text.
ToolTip Gets an object of type RibbonToolTip that displays text when the mouse pointer hovers over the item.

See Also