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

- **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` › `TXTextControl.Windows.Forms.Ribbon.RibbonButton`
- **Implements:** `System.ComponentModel.INotifyPropertyChanged`
- **Path:** TX Text Control .NET for Windows Forms > Reference > TXTextControl.Windows.Forms.Ribbon > RibbonToggleButton Class
- **1685 words**
- **Web URL:** https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbontogglebutton/
- **LLMs URL:** https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbontogglebutton/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbontogglebutton/llms-full.txt

---

### Description

The RibbonToggleButton class is a [checkable](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbontogglebutton/checked-property/llms-full.txt) 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). The RibbonToggleButton class is inherited from the [RibbonButton](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbonbutton/llms-full.txt) class. The following describes only the properties, methods and events defined through the RibbonToggleButton class.

### Syntax

```csharp
public class RibbonToggleButton : RibbonButton
```

```vbnet
Public Class RibbonToggleButton
    Inherits RibbonButton
```

### Examples

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

```csharp
using TXTextControl.Windows.Forms.Ribbon.RibbonToggleButton ribbonToggleButton = new();
ribbonToggleButton.Checked = true;
```

```vbnet
Dim ribbonToggleButton As New TXTextControl.Windows.Forms.Ribbon.RibbonToggleButton()
ribbonToggleButton.Checked = True
```

---

## In This Section

- [RibbonToggleButton.Checked Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbontogglebutton/checked-property/llms-full.txt): Gets or set a value indicating whether this RibbonToggleButton is checked.
- [RibbonToggleButton.CheckedChanged Event](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbontogglebutton/checkedchanged-event/llms-full.txt): Occurs when the value of the Checked property changes.
- [RibbonToggleButton Constructor](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbontogglebutton/constructor/llms-full.txt): Initializes a new instance of the RibbonToggleButton class.

---

## Nearby

- **Previous:** [RibbonTextBox.ValidationMode Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbontextbox/validationmode-property/llms-full.txt)
- **Next:** [RibbonToggleButton.Checked Property](https://docs.textcontrol.com/tx-text-control-dotnet-winforms/reference/txtextcontrol-windows-forms-ribbon/ribbontogglebutton/checked-property/llms-full.txt)