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

Members

MemberValueDescription
TXITEM_PageSetupGroup0Identifies the TXITEM_PageSetupGroup ribbon group inside the RibbonPageLayoutTab 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_PageSetupGroup_DialogBoxLauncher1Identifies the dialog box launcher of the TXITEM_PageSetupGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle and ToolTipDescription resources. Limitations: The FindItem method returns null when passing this RibbonItem as an argument.
TXITEM_PageMargins2Identifies the TXITEM_PageMargins ribbon item inside the TXITEM_PageSetupGroup 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_Orientation3Identifies the TXITEM_Orientation ribbon item inside the TXITEM_PageSetupGroup 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_PageSize4Identifies the TXITEM_PageSize ribbon item inside the TXITEM_PageSetupGroup 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_ColumnsAndBreaksGroup5Identifies the TXITEM_ColumnsAndBreaksGroup ribbon group inside the RibbonPageLayoutTab 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_ColumnsAndBreaksGroup_DialogBoxLauncher6Identifies the dialog box launcher of the TXITEM_ColumnsAndBreaksGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle and ToolTipDescription resources. Limitations: The FindItem method returns null when passing this RibbonItem as an argument.
TXITEM_Columns7Identifies the TXITEM_Columns ribbon item inside the TXITEM_ColumnsAndBreaksGroup 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_Breaks8Identifies the TXITEM_Breaks ribbon item inside the TXITEM_ColumnsAndBreaksGroup 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_PageBackgroundAndBordersGroup9Identifies the TXITEM_PageBackgroundAndBordersGroup ribbon group inside the RibbonPageLayoutTab 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_PageBackgroundAndBordersGroup_DialogBoxLauncher10Identifies the dialog box launcher of the TXITEM_PageBackgroundAndBordersGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle and ToolTipDescription resources. Limitations: The FindItem method returns null when passing this RibbonItem as an argument.
TXITEM_PageColor11Identifies the TXITEM_PageColor ribbon item inside the TXITEM_PageBackgroundAndBordersGroup 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_PageBorders12Identifies the TXITEM_PageBorders ribbon item inside the TXITEM_PageBackgroundAndBordersGroup 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_PageLineColor13Identifies the TXITEM_PageLineColor ribbon item inside the TXITEM_PageBackgroundAndBordersGroup 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_PageLineWidth14Identifies the TXITEM_PageLineWidth ribbon item inside the TXITEM_PageBackgroundAndBordersGroup 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_Page Setup Group value from the Ribbon Item enumeration and uses it as a documented workflow choice.

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