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 RibbonFrameLayoutTab 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 RibbonFrameLayoutTab.RibbonItemPublic Enum RibbonFrameLayoutTab.RibbonItemMembers
| Member | Value | Description |
|---|---|---|
| TXITEM_ObjectArrangeGroup | 0 | Identifies the TXITEM_ObjectArrangeGroup ribbon group inside the RibbonFrameLayoutTab 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_ObjectArrangeGroup_DialogBoxLauncher | 1 | Identifies the dialog box launcher of the TXITEM_ObjectArrangeGroup 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_WrapText | 2 | Identifies the TXITEM_WrapText ribbon item inside the TXITEM_ObjectArrangeGroup 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_BringToFront | 3 | Identifies the TXITEM_BringToFront ribbon item inside the TXITEM_ObjectArrangeGroup 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_SendToBack | 4 | Identifies the TXITEM_SendToBack ribbon item inside the TXITEM_ObjectArrangeGroup 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_Position | 5 | Identifies the TXITEM_Position ribbon item inside the TXITEM_ObjectArrangeGroup 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_ObjectSizeGroup | 6 | Identifies the TXITEM_ObjectSizeGroup ribbon group inside the RibbonFrameLayoutTab 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_ObjectSizeGroup_DialogBoxLauncher | 7 | Identifies the dialog box launcher of the TXITEM_ObjectSizeGroup 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_ObjectHeight | 8 | Identifies the TXITEM_ObjectHeight ribbon item inside the TXITEM_ObjectSizeGroup 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_ObjectWidth | 9 | Identifies the TXITEM_ObjectWidth ribbon item inside the TXITEM_ObjectSizeGroup 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_TextFrame_BordersandBackgroundGroup | 10 | Identifies the TXITEM_TextFrame_BordersandBackgroundGroup ribbon group inside the RibbonFrameLayoutTab 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_TextFrame_BordersandBackgroundGroup_DialogBoxLauncher | 11 | Identifies the dialog box launcher of the TXITEM_TextFrame_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_TextFrameBackColor | 12 | Identifies the TXITEM_TextFrameBackColor ribbon item inside the TXITEM_TextFrame_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_TextFrameTransparency | 13 | Identifies the TXITEM_TextFrameTransparency ribbon item inside the TXITEM_TextFrame_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_TextFrameLineWidth | 14 | Identifies the TXITEM_TextFrameLineWidth ribbon item inside the TXITEM_TextFrame_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_TextFrameBorderColor | 15 | Identifies the TXITEM_TextFrameBorderColor ribbon item inside the TXITEM_TextFrame_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_Drawing_BordersandBackgroundGroup | 16 | Identifies the TXITEM_Drawing_BordersandBackgroundGroup ribbon group inside the RibbonFrameLayoutTab 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_Drawing_BordersandBackgroundGroup_DialogBoxLauncher | 17 | Identifies the dialog box launcher of the TXITEM_Drawing_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_DrawingLineColor | 18 | Identifies the TXITEM_DrawingLineColor ribbon item inside the TXITEM_Drawing_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_DrawingBackColor | 19 | Identifies the TXITEM_DrawingBackColor ribbon item inside the TXITEM_Drawing_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_DrawingLineWidth | 20 | Identifies the TXITEM_DrawingLineWidth ribbon item inside the TXITEM_Drawing_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_DrawingTransparency | 21 | Identifies the TXITEM_DrawingTransparency ribbon item inside the TXITEM_Drawing_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_DrawingRotation | 22 | Identifies the TXITEM_DrawingRotation ribbon item inside the TXITEM_Drawing_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_Barcode_ColorsAndAlignmentGroup | 23 | Identifies the TXITEM_Barcode_ColorsAndAlignmentGroup ribbon group inside the RibbonFrameLayoutTab 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_Barcode_ColorsAndAlignmentGroup_DialogBoxLauncher | 24 | Identifies the dialog box launcher of the TXITEM_Barcode_ColorsAndAlignmentGroup 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_BarcodeForeColor | 25 | Identifies the TXITEM_BarcodeForeColor ribbon item inside the TXITEM_Barcode_ColorsAndAlignmentGroup 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_BarcodeBackColor | 26 | Identifies the TXITEM_BarcodeBackColor ribbon item inside the TXITEM_Barcode_ColorsAndAlignmentGroup 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_BarcodeTransparency | 27 | Identifies the TXITEM_BarcodeTransparency ribbon item inside the TXITEM_Barcode_ColorsAndAlignmentGroup 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_BarcodeHorizontalAlignment | 28 | Identifies the TXITEM_BarcodeHorizontalAlignment ribbon item inside the TXITEM_Barcode_ColorsAndAlignmentGroup 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_BarcodeVerticalAlignment | 29 | Identifies the TXITEM_BarcodeVerticalAlignment ribbon item inside the TXITEM_Barcode_ColorsAndAlignmentGroup 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_BarcodeRotation | 30 | Identifies the TXITEM_BarcodeRotation ribbon item inside the TXITEM_Barcode_ColorsAndAlignmentGroup 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_Chart_TypeAndAppearanceGroup | 31 | Identifies the TXITEM_Chart_TypeAndAppearanceGroup ribbon group inside the RibbonFrameLayoutTab 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_Chart_TypeAndAppearanceGroup_DialogBoxLauncher | 32 | Identifies the dialog box launcher of the TXITEM_Chart_TypeAndAppearanceGroup 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_ChartType | 33 | Identifies the TXITEM_ChartType ribbon item inside the TXITEM_Chart_TypeAndAppearanceGroup 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_ChartIs3D | 34 | Identifies the TXITEM_ChartIs3D ribbon item inside the TXITEM_Chart_TypeAndAppearanceGroup 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_ChartRotation | 35 | Identifies the TXITEM_ChartRotation ribbon item inside the TXITEM_Chart_TypeAndAppearanceGroup 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_ChartHasRightAngleAxes | 36 | Identifies the TXITEM_ChartHasRightAngleAxes ribbon item inside the TXITEM_Chart_TypeAndAppearanceGroup 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_ChartInclination | 37 | Identifies the TXITEM_ChartInclination ribbon item inside the TXITEM_Chart_TypeAndAppearanceGroup 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_ChartPerspective | 38 | Identifies the TXITEM_ChartPerspective ribbon item inside the TXITEM_Chart_TypeAndAppearanceGroup 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_ObjectPropertiesGroup | 39 | Identifies the TXITEM_ObjectPropertiesGroup ribbon group inside the RibbonFrameLayoutTab 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_ObjectName | 40 | Identifies the TXITEM_ObjectName ribbon item inside the TXITEM_ObjectPropertiesGroup 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_ObjectID | 41 | Identifies the TXITEM_ObjectID ribbon item inside the TXITEM_ObjectPropertiesGroup 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_ObjectDescriptiveText | 42 | Identifies the TXITEM_ObjectDescriptiveText ribbon item inside the TXITEM_ObjectPropertiesGroup 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_Signature_SignerInfoGroup | 43 | Identifies the TXITEM_Signature_SignerInfoGroup ribbon group inside the RibbonFrameLayoutTab 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_SignerName | 44 | Identifies the TXITEM_SignerName ribbon item inside the TXITEM_Signature_SignerInfoGroup 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_SignerTitle | 45 | Identifies the TXITEM_SignerTitle ribbon item inside the TXITEM_Signature_SignerInfoGroup 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_SignerAddress | 46 | Identifies the TXITEM_SignerAddress ribbon item inside the TXITEM_Signature_SignerInfoGroup 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_SignerContactInfo | 47 | Identifies the TXITEM_SignerContactInfo ribbon item inside the TXITEM_Signature_SignerInfoGroup 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_SignerReason | 48 | Identifies the TXITEM_SignerReason ribbon item inside the TXITEM_Signature_SignerInfoGroup 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_Object Arrange Group value from the Ribbon Item enumeration and uses it as a documented workflow choice.
TXTextControl.Windows.Forms.Ribbon.RibbonFrameLayoutTab.RibbonItem value = TXTextControl.Windows.Forms.Ribbon.RibbonFrameLayoutTab.RibbonItem.TXITEM_ObjectArrangeGroup;
Console.WriteLine($"Using Ribbon Item: {value}");Dim value As TXTextControl.Windows.Forms.Ribbon.RibbonFrameLayoutTab.RibbonItem = TXTextControl.Windows.Forms.Ribbon.RibbonFrameLayoutTab.RibbonItem.TXITEM_ObjectArrangeGroup
Console.WriteLine($"Using Ribbon Item: {value}")