TX Text Control .NET for Windows Forms

RibbonItem Enumeration

Enumeration|Introduced in 29.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 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.

Syntax

public enum RibbonReferencesTab.RibbonItem

Members

MemberValueDescription
TXITEM_FootnotesGroup0Identifies the TXITEM_FootnotesGroup ribbon group inside the RibbonReferencesTab ribbon tab. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding Text and KeyTip resources.
TXITEM_InsertFootnote1Identifies the TXITEM_InsertFootnote ribbon item inside the TXITEM_FootnotesGroup 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_DeleteFootnote2Identifies the TXITEM_DeleteFootnote ribbon item inside the TXITEM_FootnotesGroup 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_EditFootnote3Identifies the TXITEM_EditFootnote ribbon item inside the TXITEM_FootnotesGroup 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_PreviousFootnote4Identifies the TXITEM_PreviousFootnote ribbon item inside the TXITEM_FootnotesGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_NextFootnote5Identifies the TXITEM_NextFootnote ribbon item inside the TXITEM_FootnotesGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_HighlightFootnoteMarks6Identifies the TXITEM_HighlightFootnoteMarks ribbon item inside the TXITEM_FootnotesGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_FootnotesStartNumber7Identifies the TXITEM_FootnotesStartNumber ribbon item inside the TXITEM_FootnotesGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_FootnotesNumberFormat8Identifies the TXITEM_FootnotesNumberFormat ribbon item inside the TXITEM_FootnotesGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_TableOfContentsGroup9Identifies the TXITEM_TableOfContentsGroup ribbon group inside the RibbonReferencesTab 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_InsertTableOfContents10Identifies the TXITEM_InsertTableOfContents ribbon item inside the TXITEM_TableOfContentsGroup 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_DeleteTableOfContents11Identifies the TXITEM_DeleteTableOfContents ribbon item inside the TXITEM_TableOfContentsGroup 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_UpdateTableOfContents12Identifies the TXITEM_UpdateTableOfContents ribbon item inside the TXITEM_TableOfContentsGroup 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_ModifyTableOfContents13Identifies the TXITEM_ModifyTableOfContents ribbon item inside the TXITEM_TableOfContentsGroup 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_TableOfContentsPropertiesGroup14Identifies the TXITEM_TableOfContentsPropertiesGroup ribbon group inside the RibbonReferencesTab 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_TOCMinimumStructureLevel15Identifies the TXITEM_TOCMinimumStructureLevel ribbon item inside the TXITEM_TableOfContentsPropertiesGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_TOCMaximumStructureLevel16Identifies the TXITEM_TOCMaximumStructureLevel ribbon item inside the TXITEM_TableOfContentsPropertiesGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_TOCCreateHyperlinks17Identifies the TXITEM_TOCCreateHyperlinks ribbon item inside the TXITEM_TableOfContentsPropertiesGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_TOCTitle18Identifies the TXITEM_TOCTitle ribbon item inside the TXITEM_TableOfContentsPropertiesGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_TOCShowPageNumbers19Identifies the TXITEM_TOCShowPageNumbers ribbon item inside the TXITEM_TableOfContentsPropertiesGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_TOCRightAlignPageNumbers20Identifies the TXITEM_TOCRightAlignPageNumbers ribbon item inside the TXITEM_TableOfContentsPropertiesGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_ParagraphStructureLevelsGroup21Identifies the TXITEM_ParagraphStructureLevelsGroup ribbon group inside the RibbonReferencesTab 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_StructureLevelStyles22Identifies the TXITEM_StructureLevelStyles ribbon item inside the TXITEM_ParagraphStructureLevelsGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding KeyTip resource.
TXITEM_AddParagraph23Identifies the TXITEM_AddParagraph ribbon item inside the TXITEM_ParagraphStructureLevelsGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text, ToolTipTitle, ToolTipDescription and KeyTip resources.

Examples

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

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