RibbonButton.KeyTip Property

Definition

Namespace:

Microsoft.Office.Tools.Ribbon

Assembly:

Microsoft.Office.Tools.Common.dll

Gets or sets the keyboard shortcut of the button.

public:
 property System::String ^ KeyTip { System::String ^ get(); void set(System::String ^ value); };

public string KeyTip { get; set; }

member this.KeyTip : string with get, set

Public Property KeyTip As String

Property Value

String

A string that represents the keyboard shortcut of the button.

Examples

The following example assigns a KeyTip to a button and a check box.

To run this code example, you must first perform the following steps:

1. Add a Ribbon (Visual Designer) item to a project created by using Office development tools in Visual Studio.

2. Add a group to the custom tab.

3. Add a button and a check box to the group.

private void AssignKeyTips()
{
    tab1.KeyTip = "Z";
    button1.KeyTip = "A1";
    checkBox1.KeyTip = "A2";
}

Private Sub AssignKeyTips()
    tab1.KeyTip = "Z"
    button1.KeyTip = "A1"
    checkBox1.KeyTip = "A2"
End Sub

Remarks

A KeyTip must be from 1 to 3 uppercase characters, and must not contain spaces, tabs, or newline characters.

KeyTips are sometimes known as access keys or accelerators and are used as shortcut key combinations that activate controls. KeyTips appear on the Ribbon when you press the ALT key. If your KeyTip conflicts with KeyTips for built-in controls or from other add-ins, Microsoft Office might assign non-conflicting KeyTip values automatically.

For more information, see Use the keyboard to work with Ribbon programs.