HorizontalRibbonGroup 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 - Horizontal
Ribbon Group
Description
The HorizontalRibbonGroup class represents a logical group of controls as they appear on a RibbonTab. An instance of a HorizontalRibbonGroup 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 HorizontalRibbonGroup are arranged in rows. To arrange them in columns it is recommend to use an instance of type RibbonGroup. A HorizontalRibbonGroup is inherited from the RibbonGroup class. The following describes only the properties, methods and events defined through the HorizontalRibbonGroup class.
Syntax
public class HorizontalRibbonGroup : RibbonGroupPublic Class HorizontalRibbonGroup
Inherits RibbonGroupExamples
The following example creates a Horizontal Ribbon Group instance and configures its horizontal content alignment setting for a document workflow.
using TXTextControl.Windows.Forms.Ribbon.HorizontalRibbonGroup horizontalRibbonGroup = new();
horizontalRibbonGroup.HorizontalContentAlignment = TXTextControl.HorizontalAlignment.Center;Dim horizontalRibbonGroup As New TXTextControl.Windows.Forms.Ribbon.HorizontalRibbonGroup()
horizontalRibbonGroup.HorizontalContentAlignment = TXTextControl.HorizontalAlignment.CenterMembers
Constructors
| Constructor | Description |
|---|---|
| HorizontalRibbonGroup | Initializes a new instance of the HorizontalRibbonGroup class. |
| RibbonGroup | Initializes a new instance of the RibbonGroup class. (Inherited from RibbonGroup.) |
Properties
| Property | Description |
|---|---|
| DialogBoxLauncher | Gets an object of type DialogBoxLauncher which represents the RibbonGroup's dialog box launcher item. (Inherited from RibbonGroup.) |
| HorizontalContentAlignment | Gets or sets the ribbon group's horizontal content alignment. The default value is TXTextControl.HorizontalAlignment.Left. (Inherited from RibbonGroup.) |
| IsAddToQuickAccessToolbarEnabled | Gets or sets a value whether the RibbonGroup can be added to the quick access toolbar. (Inherited from RibbonGroup.) |
| KeyTip | Gets or sets the keyboard shortcut of the RibbonGroup. (Inherited from 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. (Inherited from RibbonGroup.) |
| 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. (Inherited from RibbonGroup.) |
| RowCount | Gets or sets the number of rows in the RibbonGroup. (Inherited from RibbonGroup.) |
| ShowSeperator | Gets or sets a value whether the RibbonGroup's separator is shown. The default value is true. (Inherited from RibbonGroup.) |
| 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. (Inherited from RibbonGroup.) |
| Text | Overridden. Gets or sets the RibbonGroup's footer text. (Inherited from RibbonGroup.) |
| ToolTip | Gets an object of type RibbonToolTip that displays text when the mouse pointer hovers over this RibbonGroup. (Inherited from RibbonGroup.) |
Methods
| Method | Description |
|---|---|
| Add | Adds a control of type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator to the end of a specific row inside the horizontal ribbon group. |
| AddRange | Adds an array of controls to the end of a specific row. These controls must be objects of type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator. |
| Insert | Inserts a control of type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator at the specified index. |
| InsertRange | Inserts an array of controls at the specified index. These controls must be objects of type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator. |