GetKeyTip Method

Description

Gets the key tip that is associated with an item and specified by the identifier parameter. Such an identifier can be the string conversion of an enumeration that is associated with an item (such as RibbonFormattingTab.RibbonItem.TXITEM_Paste). By default CultureInfo.CurrentUiCulture determines the language of the key tip resources. If no resource translation is provided, that corresponds to the current ui culture or the value of the culture parameter, the returned key tip is based on the English resources.

Syntax

GetKeyTip(string)

Gets the key tip that is associated with the specified item identifier.

public static string GetKeyTip(string identifier);

Public Shared Function GetKeyTip(identifier As String) As String

GetKeyTip(string, CultureInfo)

Gets the key tip that is associated with the specified item identifier in the specified language.

public static string GetKeyTip(string identifier, CultureInfo culture);

Public Shared Function GetKeyTip(identifier As String, culture As CultureInfo) As String

Return Value

The key tip that is assigned to the item. If no key tip is associated with the source, the method returns an empty string.

Examples

The following example retrieves key tip from the resource provider.

var result = TXTextControl.Windows.Forms.ResourceProvider.GetKeyTip("Quarterly report", System.Globalization.CultureInfo.GetCultureInfo("en-US"));
Console.WriteLine($"Get Key Tip result: {result}");

Dim result = TXTextControl.Windows.Forms.ResourceProvider.GetKeyTip("Quarterly report", System.Globalization.CultureInfo.GetCultureInfo("en-US"))
Console.WriteLine($"Get Key Tip result: {result}")