RibbonItem Enumeration
- Namespace
TXTextControl.WPF
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WPF. SDK
- Assembly
TXTextControl.WPF. dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WPF. SDK TXTextControl.from the setup.WPF. dll
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 RibbonPageLayoutTab's FrameworkElement.FindName 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.RibbonItemPublic Enum RibbonPageLayoutTab.RibbonItemMembers
| Member | Value | Description |
|---|---|---|
| TXITEM_PageSetupGroup | 0 | Identifies 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_PageMargins | 1 | Identifies 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_Orientation | 2 | Identifies 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_PageSize | 3 | Identifies 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_ColumnsAndBreaksGroup | 4 | Identifies 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_Columns | 5 | Identifies 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_Breaks | 6 | Identifies 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_PageBackgroundAndBordersGroup | 7 | Identifies 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_PageColor | 8 | Identifies 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_PageBorders | 9 | Identifies 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_PageLineColor | 10 | Identifies 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_PageLineWidth | 11 | Identifies 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.WPF.RibbonPageLayoutTab.RibbonItem value = TXTextControl.WPF.RibbonPageLayoutTab.RibbonItem.TXITEM_PageSetupGroup;
Console.WriteLine($"Using Ribbon Item: {value}");Dim value As TXTextControl.WPF.RibbonPageLayoutTab.RibbonItem = TXTextControl.WPF.RibbonPageLayoutTab.RibbonItem.TXITEM_PageSetupGroup
Console.WriteLine($"Using Ribbon Item: {value}")