TXTextControl.Windows.Forms.Ribbon.RibbonSplitButton Class

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.

Introduced: 24.0.

Syntax

[C#]
public class RibbonSplitButton : RibbonMenuButton
[Visual Basic]
Public Class RibbonSplitButton
  Inherits RibbonMenuButton

Constructors

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

Properties

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 Windows.Forms.Ribbon.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 Windows.Forms.Ribbon.RibbonMenuButton.)
DropDownItems Gets the collection of controls in the drop-down menu that is associated with this RibbonMenuButton. (Inherited from Windows.Forms.Ribbon.RibbonMenuButton.)
IsAddToQuickAccessToolbarEnabled Gets or sets value whether the RibbonButton can be added to the quick access toolbar. (Inherited from Windows.Forms.Ribbon.RibbonMenuButton.)
KeyTip Gets or sets the keyboard shortcut of the RibbonButton. (Inherited from Windows.Forms.Ribbon.RibbonMenuButton.)
LargeIcon Gets or sets a 32x32 icon for this RibbonButton. (Inherited from Windows.Forms.Ribbon.RibbonMenuButton.)
ParentCollection Gets the RibbonItemCollection that contains this RibbonButton. (Inherited from Windows.Forms.Ribbon.RibbonMenuButton.)
SmallIcon Gets or sets a 16x16 icon for this RibbonButton. (Inherited from Windows.Forms.Ribbon.RibbonMenuButton.)
Text Overridden. Gets or sets the RibbonButton's text. (Inherited from Windows.Forms.Ribbon.RibbonMenuButton.)
ToolTip Gets an object of type RibbonToolTip that displays text when the mouse pointer hovers over the item. (Inherited from Windows.Forms.Ribbon.RibbonMenuButton.)

Events

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 Windows.Forms.Ribbon.RibbonMenuButton.)
DropDownOpening Occurs as the RibbonMenuButton's drop-down menu is opening. (Inherited from Windows.Forms.Ribbon.RibbonMenuButton.)

See Also