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 RibbonViewTab 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 RibbonViewTab.RibbonItemPublic Enum RibbonViewTab.RibbonItemMembers
| Member | Value | Description |
|---|---|---|
| TXITEM_DocumentViewsGroup | 0 | Identifies the TXITEM_DocumentViewsGroup ribbon group inside the RibbonViewTab 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_PrintLayout | 1 | Identifies the TXITEM_PrintLayout ribbon item inside the TXITEM_DocumentViewsGroup 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_Draft | 2 | Identifies the TXITEM_Draft ribbon item inside the TXITEM_DocumentViewsGroup 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_ZoomGroup | 3 | Identifies the TXITEM_ZoomGroup ribbon group inside the RibbonViewTab 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_ZoomFactor | 4 | Identifies the TXITEM_ZoomFactor ribbon item inside the TXITEM_ZoomGroup 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_Zoom100 | 5 | Identifies the TXITEM_Zoom100 ribbon item inside the TXITEM_ZoomGroup 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_FullPage | 6 | Identifies the TXITEM_FullPage ribbon item inside the TXITEM_ZoomGroup 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_PageWidth | 7 | Identifies the TXITEM_PageWidth ribbon item inside the TXITEM_ZoomGroup 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_TextWidth | 8 | Identifies the TXITEM_TextWidth ribbon item inside the TXITEM_ZoomGroup 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_ToolbarsGroup | 9 | Identifies the TXITEM_ToolbarsGroup ribbon group inside the RibbonViewTab 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_HorizontalRuler | 10 | Identifies the TXITEM_HorizontalRuler ribbon item inside the TXITEM_ToolbarsGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding Text, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_VerticalRuler | 11 | Identifies the TXITEM_VerticalRuler ribbon item inside the TXITEM_ToolbarsGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding Text, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_StatusBar | 12 | Identifies the TXITEM_StatusBar ribbon item inside the TXITEM_ToolbarsGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding Text, ToolTipTitle, ToolTipDescription and KeyTip resources. |
| TXITEM_ShowGroup | 13 | Identifies the TXITEM_ShowGroup ribbon group inside the RibbonViewTab 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_ShowTableGridlines | 14 | Identifies the TXITEM_ShowTableGridlines ribbon item inside the TXITEM_ShowGroup 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_ShowBookmarkMarkers | 15 | Identifies the TXITEM_ShowBookmarkMarkers ribbon item inside the TXITEM_ShowGroup 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_ShowTextFrameMarkersLines | 16 | Identifies the TXITEM_ShowTextFrameMarkersLines ribbon item inside the TXITEM_ShowGroup 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_ShowDrawingFrameMarkersLines | 17 | Identifies the TXITEM_ShowDrawingFrameMarkersLines ribbon item inside the TXITEM_ShowGroup 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_ShowControlChars | 18 | Identifies the TXITEM_ShowControlChars ribbon item inside the TXITEM_ShowGroup 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_ShowFrameAnchors | 19 | Identifies the TXITEM_ShowFrameAnchors ribbon item inside the TXITEM_ShowGroup 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_Document Views Group value from the Ribbon Item enumeration and uses it as a documented workflow choice.
TXTextControl.Windows.Forms.Ribbon.RibbonViewTab.RibbonItem value = TXTextControl.Windows.Forms.Ribbon.RibbonViewTab.RibbonItem.TXITEM_DocumentViewsGroup;
Console.WriteLine($"Using Ribbon Item: {value}");Dim value As TXTextControl.Windows.Forms.Ribbon.RibbonViewTab.RibbonItem = TXTextControl.Windows.Forms.Ribbon.RibbonViewTab.RibbonItem.TXITEM_DocumentViewsGroup
Console.WriteLine($"Using Ribbon Item: {value}")