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

- **Product:** TX Text Control .NET for Windows Forms
- **Section:** Reference
- **Kind:** Class
- **Introduced:** 24.0
- **Namespace:** `TXTextControl.Windows.Forms.Ribbon`
- **Package:** `TXTextControl.TextControl.WinForms.SDK` (assembly `TXTextControl.Windows.Forms.dll`, from the private NuGet feed or Text Control Offline Packages)
- **.NET Framework:** reference `TXTextControl.Windows.Forms.dll` from the setup
- **Inherits:** `System.Windows.Forms.Control`
- **Implements:** `System.ComponentModel.INotifyPropertyChanged`
- **Derived:** `TXTextControl.Windows.Forms.Ribbon.RibbonMenuButton`, `TXTextControl.Windows.Forms.Ribbon.RibbonToggleButton`
- **Path:** TX Text Control .NET for Windows Forms > Reference > TXTextControl.Windows.Forms.Ribbon > RibbonButton Class
- **1470 words**
- **Web URL:** https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/
- **LLMs URL:** https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/llms-full.txt

---

### Description

The RibbonButton class is a button control which can be added to a [RibbonGroup](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbongroup/llms-full.txt) or to a [RibbonMenuButton](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonmenubutton/llms-full.txt) where it is stored as an item of the [drop-down menu](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonmenubutton/dropdownitems-property/llms-full.txt). Furthermore it is the base class of the [RibbonToggleButton](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbontogglebutton/llms-full.txt) and [RibbonMenuButton](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonmenubutton/llms-full.txt) 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.

### Syntax

```csharp
public class RibbonButton : Control, INotifyPropertyChanged
```

```vbnet
Public Class RibbonButton
    Inherits Control
    Implements INotifyPropertyChanged
```

### Examples

The following example creates a Ribbon Button instance and configures its description setting for a document workflow.

```csharp
using TXTextControl.Windows.Forms.Ribbon.RibbonButton ribbonButton = new();
ribbonButton.Description = "Quarterly report";
```

```vbnet
Dim ribbonButton As New TXTextControl.Windows.Forms.Ribbon.RibbonButton()
ribbonButton.Description = "Quarterly report"
```

---

## In This Section

- [RibbonButton Constructor](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/constructor/llms-full.txt): Initializes a new instance of the RibbonButton class.
- [RibbonButton.Description Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/description-property/llms-full.txt): 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.
- [RibbonButton.DisplayMode Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/displaymode-property/llms-full.txt): Sets the RibbonButton's superordinate display settings and gets its corresponding text icon relation rendering to the current group's width.
- [RibbonButton.IsAddToQuickAccessToolbarEnabled Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/isaddtoquickaccesstoolbarenabled-property/llms-full.txt): Gets or sets a value indicating whether the RibbonButton can be added to the quick access toolbar.
- [RibbonButton.IsScalable Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/isscalable-property/llms-full.txt): Gets or sets value indicating whether the RibbonButton changes its display mode when the related ribbon group is scaled by resizing the application. The default value is true.
- [RibbonButton.KeyTip Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/keytip-property/llms-full.txt): Gets or sets the keyboard shortcut of the RibbonButton.
- [RibbonButton.LargeIcon Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/largeicon-property/llms-full.txt): Gets or sets a 32x32 1/96 inch icon for this RibbonButton. This icon is shown when the DisplayMode property is set to IconTextRelation.LargeIconLabeled. The default value is IconTextRelation.LargeIconLabeled.
- [RibbonButton.ParentCollection Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/parentcollection-property/llms-full.txt): Gets the RibbonItemCollection that contains this RibbonButton.
- [RibbonButton.SmallIcon Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/smallicon-property/llms-full.txt): Gets or sets a 16x16 1/96 inch icon for this RibbonButton. This icon is shown when the DisplayMode property is set to IconTextRelation.SmallIconLabeled or IconTextRelation.SmallIconUnlabeled.
- [RibbonButton.Text Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/text-property/llms-full.txt): Overridden. Gets or sets the RibbonButton's text.
- [RibbonButton.ToolTip Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/tooltip-property/llms-full.txt): Gets an object of type RibbonToolTip that displays text when the mouse pointer hovers over the item.

---

## Nearby

- **Previous:** [Ribbon.ReadOnly Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbon/readonly-property/llms-full.txt)
- **Next:** [RibbonButton Constructor](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/constructor/llms-full.txt)
