KeyTip Property (ToolPropsBase)

Gets or sets a string with a maximum of 3 characters that represents the mnemonic displayed for the tool when using keytips.

Syntax

Visual Basic

'Declaration
 
Public Property KeyTip As String

C#

public string KeyTip {get; set;}

Property Value

A string with a maximum of 3 characters that represents the mnemonic displayed for the tool when using keytips.

Exceptions

Exception	Description
System.ArgumentException	The value assigned has more than 3 characters.
System.NotSupportedException	The property is modified at design-time for a tool in an UltraToolbarsManager defined on a base Form or UserControl. Inherited tools must be modified at run-time or at design-time through the designer of the Form or UserControl they were created on.

Remarks

When set for the SharedProps object, this property specifies the key tip for all instances of a tool that have not had their key tip explicitly set. When set for the InstanceProps object, this property specifies the key tip for one instance of a tool.

Key tips are displayed when the ribbon is showing and the Alt key is pressed.

If the key tip for a tool conflicts with another tool in the same container, this key tip may be changed.

By default, if the key tip is not set for a tool, a unique key tip will be auto-generated for the tool. UltraToolbarsManager.AutoGenerateKeyTips and UltraToolbarsManager.Office2007UICompatibility must be False for key tips to not auto-generate.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2