The RibbonSplitButton class is a control that has a primary button that responds to a Click event and a secondary button that displays a drop-down menu when clicked. Furthermore optionally the primary button can be used as checkable button. The RibbonSplitButton can be added to a RibbonGroup or to a RibbonMenuButton where it is stored as an item of the drop-down menu. The RibbonSplitButton class is inherited from the RibbonMenuButton class. The following describes only the properties, methods and events defined through theRibbonSplitButton class.


public class RibbonSplitButton : RibbonMenuButton
Public Class RibbonSplitButton
  Inherits RibbonMenuButton

Introduced: X14.


The following example shows the RibbonSplitButton class with three properties. The first property "Text" sets the button's text and the other two properties i.e. Checkable and ButtonEnabled, incidate that the primary button is checkable and enabled.

TXTextControl.Windows.Forms.Ribbon.RibbonSplitButton ribbonSplitButton = new TXTextControl.Windows.Forms.Ribbon.RibbonSplitButton();

ribbonSplitButton.Text             = "My RibbonSplitButton";
ribbonSplitButton.Checkable        = true;
ribbonSplitButton.ButtonEnabled    = true;
Dim ribbonSplitButton As TXTextControl.Windows.Forms.Ribbon.RibbonSplitButton = New TXTextControl.Windows.Forms.Ribbon.RibbonSplitButton()

ribbonSplitButton.Text          = "My RibbonSplitButton"
ribbonSplitButton.Checkable     = True
ribbonSplitButton.ButtonEnabled = True


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


Event Description
ButtonClick Occurs as the primary button is clicked.
CheckedChanged Occurs when the value of the Checked property changes.
DropDownClosed Occurs as the RibbonMenuButton's drop-down menu is closed.
(Inherited from RibbonMenuButton)
DropDownOpening Occurs as the RibbonMenuButton's drop-down menu is opening.
(Inherited from RibbonMenuButton)


Property Description
ButtonEnabled Gets or set a value indicating whether the primary button is enabled.
Checkable Gets or set a value indicating whether the primary button is checkable.
Checked Gets or set a value indicating whether the primary button 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 RibbonMenuButton)
DisplayMode Sets the RibbonButton's superordinate display settings and gets its corresponding text icon relation rendering to the current group's width.
(Inherited from RibbonMenuButton)
DropDownItems Gets the collection of controls in the drop-down menu that is associated with this RibbonMenuButton.
(Inherited from RibbonMenuButton)
IsAddToQuickAccessToolbarEnabled Gets or sets a value indicating whether the RibbonButton can be added to the quick access toolbar.
(Inherited from RibbonMenuButton)
IsScalable Gets or sets value indicating whether the RibbonButton changes its display mode when the related ribbon group is scaled by resizing the application.
(Inherited from RibbonMenuButton)
KeyTip Gets or sets the keyboard shortcut of the RibbonButton.
(Inherited from RibbonMenuButton)
LargeIcon Gets or sets a 32x32 1/96 inch icon for this RibbonButton.
(Inherited from RibbonMenuButton)
ParentCollection Gets the RibbonItemCollection that contains this RibbonButton.
(Inherited from RibbonMenuButton)
SmallIcon Gets or sets a 16x16 1/96 inch icon for this RibbonButton.
(Inherited from RibbonMenuButton)
Text Overridden.
(Inherited from RibbonMenuButton)
ToolTip Gets an object of type RibbonToolTip that displays text when the mouse pointer hovers over the item.
(Inherited from RibbonMenuButton)