RibbonReferencesTab 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
Description
The RibbonReferencesTab class represents a Windows Forms ribbon tab for creating and editing tables of contents. To enable these settings the TextControl must be connected with the Ribbon that hosts the RibbonReferencesTab.
Syntax
public class RibbonReferencesTab : RibbonTabPublic Class RibbonReferencesTab
Inherits RibbonTabExamples
The following example creates a Ribbon References Tab instance and configures its key tip setting for a document workflow.
using TXTextControl.Windows.Forms.Ribbon.RibbonReferencesTab ribbonReferencesTab = new();
ribbonReferencesTab.KeyTip = "Quarterly report";Dim ribbonReferencesTab As New TXTextControl.Windows.Forms.Ribbon.RibbonReferencesTab()
ribbonReferencesTab.KeyTip = "Quarterly report"Members
Constructors
| Constructor | Description |
|---|---|
| RibbonReferencesTab | Initializes a new instance of the RibbonReferencesTab class. |
| RibbonTab | Initializes a new instance of the RibbonTab class. (Inherited from RibbonTab.) |
Properties
| Property | Description |
|---|---|
| KeyTip | Gets or sets the keyboard shortcut of the RibbonTab. (Inherited from RibbonTab.) |
| RibbonGroups | Gets a collection of all RibbonGroups in a RibbonTab. A RibbonGroup then hosts controls that represent application commands. The property value is of the type RibbonGroupCollection. (Inherited from RibbonTab.) |
Methods
| Method | Description |
|---|---|
| FindItem | Finds a control that has the provided RibbonReferencesTab.RibbonItem identifier. |
| ResetKeyTip | Not described in the reference. public void ResetKeyTip(); |
Enumerations
| Enumeration | Description |
|---|---|
| RibbonDropDownItem | Each RibbonDropDownItem represents a drop-down item in the RibbonReferencesTab. The corresponding string of a RibbonDropDownItem is the same as the item's Name property. The RibbonDropDownItem enumeration can be used with the ResourceProvider class that provides static methods to receive bitmaps or strings which are associated with the corresponding ribbon drop-down item. |
| RibbonItem | Each RibbonItem represents an item in the RibbonReferencesTab that is not a drop-down item. The corresponding string of a RibbonItem is the same as the item's Name property. The RibbonItem enumeration can be used with the FindItem method to get an item and manipulate it or with the ResourceProvider class that provides static methods to receive bitmaps or strings which are associated with the corresponding ribbon item. |