TX Text Control .NET for Windows Forms

RibbonReportingTab Class

Class|Introduced in 24.0
Namespace
TXTextControl.Windows.Forms.Ribbon
Package
TXTextControl.TextControl.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.Windows.Forms.dll
Install
dotnet add package TXTextControl.TextControl.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.Windows.Forms.dll from the setup.
Inherits
  1. TabPage
  2. RibbonTab
  3. RibbonReportingTab

Description

The RibbonReportingTab class represents a Windows Forms ribbon tab to integrate mail merge and reporting functionality. To modify a document by using these options the TextControl must be connected with the Ribbon that hosts the RibbonReportingTab.

Syntax

public class RibbonReportingTab : RibbonTab

Examples

The following example creates a Ribbon Reporting Tab instance and configures its key tip setting for a document workflow.

using TXTextControl.Windows.Forms.Ribbon.RibbonReportingTab ribbonReportingTab = new();
ribbonReportingTab.KeyTip = "Quarterly report";

Members

Constructors

ConstructorDescription
RibbonReportingTabInitializes a new instance of the RibbonReportingTab class.
RibbonTabInitializes a new instance of the RibbonTab class. (Inherited from RibbonTab.)

Properties

PropertyDescription
DataSourceManagerProvides the DataSourceManager that is connected with the RibbonReportingTab.
FieldNavigatorSidebarGets or sets the sidebar that is connected to the RibbonReportingTab's TXITEM_FieldNavigation button.
KeyTipGets or sets the keyboard shortcut of the RibbonTab. (Inherited from RibbonTab.)
RibbonGroupsGets 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

MethodDescription
FindItemFinds a control that has the provided RibbonReportingTab.RibbonItem identifier.
ResetKeyTipNot described in the reference. public void ResetKeyTip();

Enumerations

EnumerationDescription
RibbonDropDownItemEach RibbonDropDownItem represents a drop-down item in the RibbonReportingTab. 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.
RibbonItemEach RibbonItem represents an item in the RibbonReportingTab 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.

Further Reading

  • Windows Forms Ribbon: Displaying User-Friendly Merge Field Names –
  • Using the Reporting RibbonTab –