RibbonGroup 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
- Panel
- Ribbon
Group
- Derived
- Horizontal
Ribbon Group
Description
The RibbonGroup class represents a logical group of controls as they appear on a RibbonTab and is the base class of the HorizontalRibbonGroup class. An instance of a RibbonGroup can be added to a RibbonTab by using the Add method of its RibbonGroupCollection which is represented by the RibbonTab.RibbonGroups property. The controls of a RibbonGroup are arranged in columns. To arrange them in rows it is recommend to use an instance of type HorizontalRibbonGroup. A RibbonGroup is inherited from the System.Windows.Forms.Panel class. The following describes only the properties, methods and events defined through the RibbonGroup class. For a list of properties, methods and events inherited from the System.Windows.Forms.Panel class see the .NET Framework reference.
Syntax
public class RibbonGroup : PanelPublic Class RibbonGroup
Inherits PanelExamples
The following example creates a Ribbon Group instance and configures its horizontal content alignment setting for a document workflow.
using TXTextControl.Windows.Forms.Ribbon.RibbonGroup ribbonGroup = new();
ribbonGroup.HorizontalContentAlignment = TXTextControl.HorizontalAlignment.Center;Dim ribbonGroup As New TXTextControl.Windows.Forms.Ribbon.RibbonGroup()
ribbonGroup.HorizontalContentAlignment = TXTextControl.HorizontalAlignment.CenterMembers
Constructors
| Constructor | Description |
|---|---|
| RibbonGroup | Initializes a new instance of the RibbonGroup class. |
Properties
| Property | Description |
|---|---|
| DialogBoxLauncher | Gets an object of type DialogBoxLauncher which represents the RibbonGroup's dialog box launcher item. |
| HorizontalContentAlignment | Gets or sets the ribbon group's horizontal content alignment. The default value is TXTextControl.HorizontalAlignment.Left. |
| IsAddToQuickAccessToolbarEnabled | Gets or sets a value whether the RibbonGroup can be added to the quick access toolbar. |
| KeyTip | Gets or sets the keyboard shortcut of the RibbonGroup. |
| LargeIcon | Gets or sets an icon for this RibbonGroup. This icon is displayed by the RibbonGroup's menu button which appears when the RibbonGroup shrinks to a width where its items cannot be displayed anymore. If the size of the icon is smaller than 32x32 1/96 inch, the image is drawn centered on the menu button. |
| RibbonItems | Gets a collection of all items contained in this group. These controls can be objects of type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView or RibbonTextBox. RibbonGroups of type HorizontalRibbonGroup can also add objects of type RibbonSeperator. |
| RowCount | Gets or sets the number of rows in the RibbonGroup. |
| ShowSeperator | Gets or sets a value whether the RibbonGroup's separator is shown. The default value is true. |
| SmallIcon | Gets or sets a 16x16 1/96 inch icon for this RibbonGroup. This icon is displayed by the RibbonGroup's quick access toolbar tool strip item. |
| Text | Overridden. Gets or sets the RibbonGroup's footer text. |
| ToolTip | Gets an object of type RibbonToolTip that displays text when the mouse pointer hovers over this RibbonGroup. |
| Visible | Not described in the reference. public bool Visible { get; set; } |