RibbonMenuButton Class
- Namespace
TXTextControl.Windows. Forms. Ribbon
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WinForms. SDK
- Assembly
TXTextControl.Windows. Forms. dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WinForms. SDK TXTextControl.from the setup.Windows. Forms. dll
- Inherits
- Control
- Ribbon
Button - Ribbon
Menu Button
- Derived
- Ribbon
Split Button
- Implements
- INotify
Property Changed
Description
The RibbonMenuButton class is a button control that displays a drop-down menu when clicked. It can be added to a RibbonGroup or to another RibbonMenuButton where it is stored as an item of the drop-down menu. The drop-down menu is opened below the button if the RibbonMenuButton is part of a RibbonGroup. RibbonMenuButtons inside a drop-down menu of another RibbonMenuButton opens their drop-down menu to the right of the button. Furthermore it is the base class of the RibbonSplitButton class. The RibbonMenuButton class is inherited from the RibbonButton class. The following describes only the properties, methods and events defined through the RibbonMenuButton class.
Syntax
public class RibbonMenuButton : RibbonButtonPublic Class RibbonMenuButton
Inherits RibbonButtonExamples
The following example creates a Ribbon Menu Button instance and configures its description setting for a document workflow.
using TXTextControl.Windows.Forms.Ribbon.RibbonMenuButton ribbonMenuButton = new();
ribbonMenuButton.Description = "Quarterly report";Dim ribbonMenuButton As New TXTextControl.Windows.Forms.Ribbon.RibbonMenuButton()
ribbonMenuButton.Description = "Quarterly report"Members
Constructors
| Constructor | Description |
|---|---|
| RibbonButton | Initializes a new instance of the RibbonButton class. (Inherited from RibbonButton.) |
| RibbonMenuButton | Initializes a new instance of the RibbonMenuButton class. |
Properties
| Property | Description |
|---|---|
| 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 RibbonButton.) |
| DisplayMode | Sets the RibbonButton's superordinate display settings and gets its corresponding text icon relation rendering to the current group's width. (Inherited from RibbonButton.) |
| DropDownItems | Gets the collection of controls in the drop-down menu that is associated with this RibbonMenuButton. These controls can be objects of type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator. |
| IsAddToQuickAccessToolbarEnabled | Gets or sets a value indicating whether the RibbonButton can be added to the quick access toolbar. (Inherited from RibbonButton.) |
| IsScalable | 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. (Inherited from RibbonButton.) |
| KeyTip | Gets or sets the keyboard shortcut of the RibbonButton. (Inherited from RibbonButton.) |
| LargeIcon | 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. (Inherited from RibbonButton.) |
| ParentCollection | Gets the RibbonItemCollection that contains this RibbonButton. (Inherited from RibbonButton.) |
| SmallIcon | 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. (Inherited from RibbonButton.) |
| Text | Overridden. Gets or sets the RibbonButton's text. (Inherited from RibbonButton.) |
| ToolTip | Gets an object of type RibbonToolTip that displays text when the mouse pointer hovers over the item. (Inherited from RibbonButton.) |
Events
| Event | Description |
|---|---|
| DropDownClosed | Occurs as the RibbonMenuButton's drop-down menu is closed. |
| DropDownOpening | Occurs as the RibbonMenuButton's drop-down menu is opening. |