TX Text Control .NET for Windows Forms

RibbonItem Enumeration

Enumeration|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.

Description

Each 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.

Syntax

public enum RibbonReportingTab.RibbonItem

Members

MemberValueDescription
TXITEM_DataSourceGroup0Identifies the TXITEM_DataSourceGroup ribbon group inside the RibbonReportingTab ribbon tab. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text and KeyTip resources.
TXITEM_DataSource1Identifies the TXITEM_DataSource ribbon item inside the TXITEM_DataSourceGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_SelectMasterTable2Identifies the TXITEM_SelectMasterTable ribbon item inside the TXITEM_DataSourceGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_EditDataRelations3Identifies the TXITEM_EditDataRelations ribbon item inside the TXITEM_DataSourceGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_ConfigFile4Identifies the TXITEM_ConfigFile ribbon item inside the TXITEM_DataSourceGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_MergeFieldsGroup5Identifies the TXITEM_MergeFieldsGroup ribbon group inside the RibbonReportingTab ribbon tab. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text and KeyTip resources.
TXITEM_InsertMergeField6Identifies the TXITEM_InsertMergeField ribbon item inside the TXITEM_MergeFieldsGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_InsertSpecialField7Identifies the TXITEM_InsertSpecialField ribbon item inside the TXITEM_MergeFieldsGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_FieldProperties8Identifies the TXITEM_FieldProperties ribbon item inside the TXITEM_MergeFieldsGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_DeleteField9Identifies the TXITEM_DeleteField ribbon item inside the TXITEM_MergeFieldsGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_MergeBlocksGroup10Identifies the TXITEM_MergeBlocksGroup ribbon group inside the RibbonReportingTab ribbon tab. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text and KeyTip resources.
TXITEM_InsertMergeBlock11Identifies the TXITEM_InsertMergeBlock ribbon item inside the TXITEM_MergeBlocksGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_EditMergeBlocks12Identifies the TXITEM_EditMergeBlocks ribbon item inside the TXITEM_MergeBlocksGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_ViewGroup13Identifies the TXITEM_ViewGroup ribbon group inside the RibbonReportingTab ribbon tab. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text and KeyTip resources.
TXITEM_FieldNavigation14Identifies the TXITEM_FieldNavigation ribbon item inside the TXITEM_ViewGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding LargeIcon, SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.

Examples

The following example selects the TXITEM_Data Source Group value from the Ribbon Item enumeration and uses it as a documented workflow choice.

TXTextControl.Windows.Forms.Ribbon.RibbonReportingTab.RibbonItem value = TXTextControl.Windows.Forms.Ribbon.RibbonReportingTab.RibbonItem.TXITEM_DataSourceGroup;
Console.WriteLine($"Using Ribbon Item: {value}");