RibbonButton.KeyTip Property (2007 System)

  • Artykuł

Gets or sets the keyboard shortcut of the button.

Namespace:  Microsoft.Office.Tools.Ribbon
Assembly:  Microsoft.Office.Tools.Common.v9.0 (in Microsoft.Office.Tools.Common.v9.0.dll)

Syntax

'Declaration
Public Property KeyTip As String

'Usage
Dim instance As RibbonButton 
Dim value As String 

value = instance.KeyTip

instance.KeyTip = value

public string KeyTip { get; set; }

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

public function get KeyTip () : String 
public function set KeyTip (value : String)

Property Value

Type: System.String
A string that represents the keyboard shortcut of the button.

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.

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 Visual Studio Tools for Office project.

  2. Add a group to the custom tab.

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

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

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

.NET Framework Security

See Also

Reference

RibbonButton Class

RibbonButton Members

Microsoft.Office.Tools.Ribbon Namespace

Other Resources

Ribbon Overview

Ribbon Object Model Overview