TX Text Control .NET for Windows Forms

RibbonItem Enumeration

Enumeration|Introduced in 25.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 RibbonPermissionsTab 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 RibbonPermissionsTab.RibbonItem

Members

MemberValueDescription
TXITEM_RestrictFormattingGroup0Identifies the TXITEM_RestrictFormattingGroup ribbon group inside the RibbonPermissionsTab 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_AllowFormatting1Identifies the TXITEM_AllowFormatting ribbon item inside the TXITEM_RestrictFormattingGroup 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_AllowFormattingStyles2Identifies the TXITEM_AllowFormattingStyles ribbon item inside the TXITEM_RestrictFormattingGroup 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_RestrictEditingGroup3Identifies the TXITEM_RestrictEditingGroup ribbon group inside the RibbonPermissionsTab 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_AllowPrinting4Identifies the TXITEM_AllowPrinting ribbon item inside the TXITEM_RestrictEditingGroup 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_AllowCopy5Identifies the TXITEM_AllowCopy ribbon item inside the TXITEM_RestrictEditingGroup 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_FillInFormFields6Identifies the TXITEM_FillInFormFields ribbon item inside the TXITEM_RestrictEditingGroup 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_ReadOnly7Identifies the TXITEM_ReadOnly ribbon item inside the TXITEM_RestrictEditingGroup 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_ReadOnlyExceptionsGroup8Identifies the TXITEM_ReadOnlyExceptionsGroup ribbon group inside the RibbonPermissionsTab 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_ReadOnlyExceptionsGroup_DialogBoxLauncher9Identifies the dialog box launcher of the TXITEM_ReadOnlyExceptionsGroup 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_Users10Identifies the TXITEM_Users ribbon item inside the TXITEM_ReadOnlyExceptionsGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding ToolTipTitle, ToolTipDescription and KeyTip resources.
TXITEM_EditRestrictedDocumentGroup11Identifies the TXITEM_EditRestrictedDocumentGroup ribbon group inside the RibbonPermissionsTab 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_EnforceProtection12Identifies the TXITEM_EnforceProtection ribbon item inside the TXITEM_EditRestrictedDocumentGroup 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_HighlightEditableRegions13Identifies the TXITEM_HighlightEditableRegions ribbon item inside the TXITEM_EditRestrictedDocumentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text and KeyTip resources.
TXITEM_PreviousEditableRegion14Identifies the TXITEM_PreviousEditableRegion ribbon item inside the TXITEM_EditRestrictedDocumentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text and KeyTip resources.
TXITEM_NextEditableRegion15Identifies the TXITEM_NextEditableRegion ribbon item inside the TXITEM_EditRestrictedDocumentGroup ribbon group. The string conversion of that identifier can be passed to the appropriate ResourceProvider method to get the corresponding SmallIcon, Text and KeyTip resources.

Examples

The following example selects the TXITEM_Restrict Formatting Group value from the Ribbon Item enumeration and uses it as a documented workflow choice.

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