TX Text Control .NET for Windows Forms

RibbonToggleButton Class

Class|Introduced in 24.0
Namespace
TXTextControl.Windows.Forms.Ribbon
Package
TXTextControl.TextControl.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.Windows.Forms.dll
Install
dotnet add package TXTextControl.TextControl.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.Windows.Forms.dll from the setup.
Inherits
  1. Control
  2. RibbonButton
  3. RibbonToggleButton
Implements
INotifyPropertyChanged

Description

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.

Syntax

public class RibbonToggleButton : RibbonButton

Examples

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

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

Members

Constructors

ConstructorDescription
RibbonButtonInitializes a new instance of the RibbonButton class. (Inherited from RibbonButton.)
RibbonToggleButtonInitializes a new instance of the RibbonToggleButton class.

Properties

PropertyDescription
CheckedGets or set a value indicating whether this RibbonToggleButton is checked.
DescriptionGets 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 RibbonButton.)
DisplayModeSets the RibbonButton's superordinate display settings and gets its corresponding text icon relation rendering to the current group's width. (Inherited from RibbonButton.)
IsAddToQuickAccessToolbarEnabledGets or sets a value indicating whether the RibbonButton can be added to the quick access toolbar. (Inherited from RibbonButton.)
IsScalableGets 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. (Inherited from RibbonButton.)
KeyTipGets or sets the keyboard shortcut of the RibbonButton. (Inherited from RibbonButton.)
LargeIconGets 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. (Inherited from RibbonButton.)
ParentCollectionGets the RibbonItemCollection that contains this RibbonButton. (Inherited from RibbonButton.)
SmallIconGets 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. (Inherited from RibbonButton.)
TextOverridden. Gets or sets the RibbonButton's text. (Inherited from RibbonButton.)
ToolTipGets an object of type RibbonToolTip that displays text when the mouse pointer hovers over the item. (Inherited from RibbonButton.)

Events

EventDescription
CheckedChangedOccurs when the value of the Checked property changes.