RibbonItem Enumeration
- Namespace
TXTextControl.Windows. Forms. Ribbon
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WinForms. SDK
- Assembly
TXTextControl.Windows. Forms. dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WinForms. SDK TXTextControl.from the setup.Windows. Forms. dll
Description
Each RibbonItem represents an item in the RibbonTableLayoutTab 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 RibbonTableLayoutTab.RibbonItemPublic Enum RibbonTableLayoutTab.RibbonItemMembers
| Member | Value | Description |
|---|---|---|
| TXITEM_TableLayoutGroup | 0 | Identifies the TXITEM_TableLayoutGroup ribbon group inside the RibbonTableLayoutTab 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_SelectTable | 1 | Identifies the TXITEM_SelectTable ribbon item inside the TXITEM_TableLayoutGroup 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_TableGridLines | 2 | Identifies the TXITEM_TableGridLines ribbon item inside the TXITEM_TableLayoutGroup 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_TableProperties | 3 | Identifies the TXITEM_TableProperties ribbon item inside the TXITEM_TableLayoutGroup 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_RowsAndColumnsGroup | 4 | Identifies the TXITEM_RowsAndColumnsGroup ribbon group inside the RibbonTableLayoutTab 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_DeleteTable | 5 | Identifies the TXITEM_DeleteTable ribbon item inside the TXITEM_RowsAndColumnsGroup 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_InsertTableRowAbove | 6 | Identifies the TXITEM_InsertTableRowAbove ribbon item inside the TXITEM_RowsAndColumnsGroup 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_InsertTableRowBelow | 7 | Identifies the TXITEM_InsertTableRowBelow ribbon item inside the TXITEM_RowsAndColumnsGroup 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_InsertTableColLeft | 8 | Identifies the TXITEM_InsertTableColLeft ribbon item inside the TXITEM_RowsAndColumnsGroup 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_InsertTableColRight | 9 | Identifies the TXITEM_InsertTableColRight ribbon item inside the TXITEM_RowsAndColumnsGroup 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_MergeGroup | 10 | Identifies the TXITEM_MergeGroup ribbon group inside the RibbonTableLayoutTab 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_MergeTableCells | 11 | Identifies the TXITEM_MergeTableCells ribbon item inside the TXITEM_MergeGroup 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_SplitTableCells | 12 | Identifies the TXITEM_SplitTableCells ribbon item inside the TXITEM_MergeGroup 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_SplitTable | 13 | Identifies the TXITEM_SplitTable ribbon item inside the TXITEM_MergeGroup 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_BordersAndBackgroundGroup | 14 | Identifies the TXITEM_BordersAndBackgroundGroup ribbon group inside the RibbonTableLayoutTab 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_BordersAndBackgroundGroup_DialogBoxLauncher | 15 | Identifies the dialog box launcher of the TXITEM_BordersAndBackgroundGroup 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_TableFrameLines | 16 | Identifies the TXITEM_TableFrameLines ribbon item inside the TXITEM_BordersAndBackgroundGroup 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_TableLineColor | 17 | Identifies the TXITEM_TableLineColor ribbon item inside the TXITEM_BordersAndBackgroundGroup 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_TableBackColor | 18 | Identifies the TXITEM_TableBackColor ribbon item inside the TXITEM_BordersAndBackgroundGroup 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_TableLineWidth | 19 | Identifies the TXITEM_TableLineWidth ribbon item inside the TXITEM_BordersAndBackgroundGroup 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_TableAlignmentGroup | 20 | Identifies the TXITEM_TableAlignmentGroup ribbon group inside the RibbonTableLayoutTab 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_TableAlignmentGroup_DialogBoxLauncher | 21 | Identifies the dialog box launcher of the TXITEM_TableAlignmentGroup 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_CellAlignTopLeft | 22 | Identifies the TXITEM_CellAlignTopLeft ribbon item inside the TXITEM_TableAlignmentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_CellAlignMiddleLeft | 23 | Identifies the TXITEM_CellAlignMiddleLeft ribbon item inside the TXITEM_TableAlignmentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_CellAlignBottomLeft | 24 | Identifies the TXITEM_CellAlignBottomLeft ribbon item inside the TXITEM_TableAlignmentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_CellAlignTopCentered | 25 | Identifies the TXITEM_CellAlignTopCentered ribbon item inside the TXITEM_TableAlignmentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_CellAlignMiddleCentered | 26 | Identifies the TXITEM_CellAlignMiddleCentered ribbon item inside the TXITEM_TableAlignmentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_CellAlignBottomCentered | 27 | Identifies the TXITEM_CellAlignBottomCentered ribbon item inside the TXITEM_TableAlignmentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_CellAlignTopRight | 28 | Identifies the TXITEM_CellAlignTopRight ribbon item inside the TXITEM_TableAlignmentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_CellAlignMiddleRight | 29 | Identifies the TXITEM_CellAlignMiddleRight ribbon item inside the TXITEM_TableAlignmentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_CellAlignBottomRight | 30 | Identifies the TXITEM_CellAlignBottomRight ribbon item inside the TXITEM_TableAlignmentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_CellAlignTopJustified | 31 | Identifies the TXITEM_CellAlignTopJustified ribbon item inside the TXITEM_TableAlignmentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_CellAlignMiddleJustified | 32 | Identifies the TXITEM_CellAlignMiddleJustified ribbon item inside the TXITEM_TableAlignmentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_CellAlignBottomJustified | 33 | Identifies the TXITEM_CellAlignBottomJustified ribbon item inside the TXITEM_TableAlignmentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_TablePropertiesGroup | 34 | Identifies the TXITEM_TablePropertiesGroup ribbon group inside the RibbonTableLayoutTab 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_TableID | 35 | Identifies the TXITEM_TableID ribbon item inside the TXITEM_TablePropertiesGroup 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_TableDescriptiveText | 36 | Identifies the TXITEM_TableDescriptiveText ribbon item inside the TXITEM_TablePropertiesGroup 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_Table Layout Group value from the Ribbon Item enumeration and uses it as a documented workflow choice.
TXTextControl.Windows.Forms.Ribbon.RibbonTableLayoutTab.RibbonItem value = TXTextControl.Windows.Forms.Ribbon.RibbonTableLayoutTab.RibbonItem.TXITEM_TableLayoutGroup;
Console.WriteLine($"Using Ribbon Item: {value}");Dim value As TXTextControl.Windows.Forms.Ribbon.RibbonTableLayoutTab.RibbonItem = TXTextControl.Windows.Forms.Ribbon.RibbonTableLayoutTab.RibbonItem.TXITEM_TableLayoutGroup
Console.WriteLine($"Using Ribbon Item: {value}")