How to add a keyboard shortcut on a Visual Studio extension?

Question

I'm trying to learn how to create a keyboard shortcut on a Visual Studio 2022 extension.

I would like to get the shortcut visible and editable at Tools > Options > Environment > Keyboard

Steps i tried:

Addded: [ProvideMenuResource("Menus.ctmenu", 1)]
Created the package and the shortcut button GUIDs at public static class PackageIds
Created the .vsct file and set the same GUID used on the button.
Modified the .vsct include on the .csproj to VSCTCompile

  
    
      Menus.ctmenu
      Designer

It does compile and install, when i hit Ctrl + W i can see the cursor changing to the loading icon for a short period of time, but the Execute() functio never gets called.

What i'm missing?

VSIXPackage.cs

using Microsoft;
using Microsoft.VisualStudio.Shell;
using Microsoft.VisualStudio.Shell.Interop;
using System;
using System.Runtime.InteropServices;
using System.Threading;
using System.ComponentModel.Design;
using System.Windows;
using Task = System.Threading.Tasks.Task;

namespace VSIX;

[PackageRegistration(UseManagedResourcesOnly = true, AllowsBackgroundLoading = true)]
[ProvideMenuResource("Menus.ctmenu", 1)]
[Guid(VSIXPackage.PackageGuidString)]
[ProvideAutoLoad(UIContextGuids.NoSolution, PackageAutoLoadFlags.BackgroundLoad)]
public sealed class VSIXPackage : AsyncPackage
{
    public const string PackageGuidString = "f9a8aea3-f579-4816-9cb5-4ae3a5d68ef7";

    protected override async Task InitializeAsync(CancellationToken cancellationToken, IProgress progress)
    {
        await this.JoinableTaskFactory.SwitchToMainThreadAsync(cancellationToken);

        var commandService = await GetServiceAsync(typeof(IMenuCommandService)) as OleMenuCommandService;
        Assumes.Present(commandService);

        var menuCommandID = new CommandID(PackageIds.guidVSIXPackageCmdSet, PackageIds.MyCommandId);
        var menuItem = new OleMenuCommand((s, e) => Execute(), menuCommandID);
        commandService.AddCommand(menuItem);
    }

    public static void Execute()
    {
        MessageBox.Show("Hello World!");
    }

    public static class PackageIds
    {
        public const string CmdSetGuid = "d858b0de-b9fa-49e8-a7ae-e080d04a78be"; // Match the GUID in .vsct
        public const int MyCommandId = 0x0100;
        public static readonly Guid guidVSIXPackageCmdSet = new Guid(CmdSetGuid);
    }
}

VSIXPackage.vsct

VSIX.csproj



  
    17.0
    $(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)
  
  
  
    Debug
    AnyCPU
    2.0
    {82b43b9b-a64c-4715-b499-d71e9ca2bd60};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}
    {C28A9253-3A5D-41ED-A3F9-FAA709A70BD9}
    Library
    Properties
    VSIX
    VSIX
    v4.7.2
    12
    true
    true
    true
    false
    false
    true
    true
    Program
    $(DevEnvDir)devenv.exe
    /rootsuffix Exp
  
  
    true
    full
    false
    bin\Debug\
    DEBUG;TRACE
    prompt
    4
  
  
    pdbonly
    true
    bin\Release\
    TRACE
    prompt
    4
  
  
    
    
  
  
    
      Designer
    
  
  
    
    
    
  
  
    
    
    
      5.0.2
    
  
  
    
      Menus.ctmenu
      Designer

The full extension project can be found here on GitHub.

Answer

Docs for creating a shortcut are at https://learn.microsoft.com/en-us/visualstudio/extensibility/binding-keyboard-shortcuts-to-menu-items?view=vs-2022 but it looks like you've got this.

When a shortcut seems to be set up ok but doesn't seem to do anything, in my experience, it's often because there are multiple commands set to use the same shortcut. However, VS does nothing to indicate that this may be the case.

See also: https://developercommunity.visualstudio.com/t/Detecting-and-reporting-conflicting-hotk/10576876

Share via

How to add a keyboard shortcut on a Visual Studio extension?

1 answer

Your answer