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 RibbonInsertTab 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 RibbonInsertTab.RibbonItem

Members

MemberValueDescription
TXITEM_PageGroup0Identifies the TXITEM_PageGroup ribbon group inside the RibbonInsertTab 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_InsertPage1Identifies the TXITEM_InsertPage ribbon item inside the TXITEM_PageGroup 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_InsertPageBreak2Identifies the TXITEM_InsertPageBreak ribbon item inside the TXITEM_PageGroup 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_TableGroup3Identifies the TXITEM_TableGroup ribbon group inside the RibbonInsertTab 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_InsertTable4Identifies the TXITEM_InsertTable ribbon item inside the TXITEM_TableGroup 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_IllustrationsGroup5Identifies the TXITEM_IllustrationsGroup ribbon group inside the RibbonInsertTab 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_InsertImage6Identifies the TXITEM_InsertImage ribbon item inside the TXITEM_IllustrationsGroup 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_InsertChart7Identifies the TXITEM_InsertChart ribbon item inside the TXITEM_IllustrationsGroup ribbon group. 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_InsertShape8Identifies the TXITEM_InsertShape ribbon item inside the TXITEM_IllustrationsGroup 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_InsertBarcode9Identifies the TXITEM_InsertBarcode ribbon item inside the TXITEM_IllustrationsGroup 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_LinksGroup10Identifies the TXITEM_LinksGroup ribbon group inside the RibbonInsertTab 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_InsertBookmark12Identifies the TXITEM_InsertBookmark ribbon item inside the TXITEM_LinksGroup 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_HeaderFooterGroup13Identifies the TXITEM_HeaderFooterGroup ribbon group inside the RibbonInsertTab 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_InsertHeader14Identifies the TXITEM_InsertHeader ribbon item inside the TXITEM_HeaderFooterGroup 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_InsertFooter15Identifies the TXITEM_InsertFooter ribbon item inside the TXITEM_HeaderFooterGroup 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_InsertPageNumber16Identifies the TXITEM_InsertPageNumber ribbon item inside the TXITEM_HeaderFooterGroup 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_TextGroup17Identifies the TXITEM_TextGroup ribbon group inside the RibbonInsertTab 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_InsertTextFrame18Identifies the TXITEM_InsertTextFrame ribbon item inside the TXITEM_TextGroup 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_InsertFile19Identifies the TXITEM_InsertFile ribbon item inside the TXITEM_TextGroup 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_InsertSignature20Identifies the TXITEM_InsertSignature ribbon item inside the TXITEM_TextGroup 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_SymbolsGroup21Identifies the TXITEM_SymbolsGroup ribbon group inside the RibbonInsertTab 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_InsertSymbol22Identifies the TXITEM_InsertSymbol ribbon item inside the TXITEM_SymbolsGroup 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_Page Group value from the Ribbon Item enumeration and uses it as a documented workflow choice.

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