Aggiunta di un menu di scelta rapida in una finestra degli strumenti - Visual Studio (Windows)

Articolo
12/15/2023

Questa procedura dettagliata inserisce un menu di scelta rapida in una finestra degli strumenti. Un menu di scelta rapida è un menu visualizzato quando un utente fa clic con il pulsante destro del mouse su un pulsante, una casella di testo o uno sfondo della finestra. I comandi di un menu di scelta rapida si comportano come i comandi in altri menu o barre degli strumenti. Per supportare un menu di scelta rapida, specificarlo nel file vsct e visualizzarlo in risposta al clic destro del mouse.

Una finestra degli strumenti è costituita da un controllo utente WPF in una classe della finestra degli strumenti personalizzata che eredita da ToolWindowPane.

Questa procedura dettagliata illustra come creare un menu di scelta rapida come menu di Visual Studio dichiarando le voci di menu nel file con estensione vsct e quindi usando Managed Package Framework per implementarle nella classe che definisce la finestra degli strumenti. Questo approccio facilita l'accesso ai comandi di Visual Studio, agli elementi dell'interfaccia utente e al modello a oggetti di Automazione.

In alternativa, se il menu di scelta rapida non accede alla funzionalità di Visual Studio, puoi usare la ContextMenu proprietà di un elemento XAML nel controllo utente. Per altre informazioni, vedere ContextMenu.

Creare un progetto VSIX denominato TWShortcutMenu e aggiungervi un modello di finestra degli strumenti denominato ShortcutMenu . Per altre informazioni sulla creazione di una finestra degli strumenti, vedere Creare un'estensione con una finestra degli strumenti.

Un menu di scelta rapida, ad esempio quello illustrato in questa procedura dettagliata, consente all'utente di selezionare da un elenco di colori usati per riempire lo sfondo della finestra degli strumenti.

In ShortcutMenuPackage.vsct trovare nell'elemento GuidSymbol denominato guidShortcutMenuPackageCmdSet e dichiarare il menu di scelta rapida, il gruppo di menu di scelta rapida e le opzioni di menu. L'elemento GuidSymbol dovrebbe ora essere simile al seguente:

<GuidSymbol name="guidShortcutMenuPackageCmdSet" value="{00000000-0000-0000-0000-0000}"> // your GUID here
    <IDSymbol name="ShortcutMenuCommandId" value="0x0100" />
    <IDSymbol name="ColorMenu" value="0x1000"/>
    <IDSymbol name="ColorGroup" value="0x1100"/>
    <IDSymbol name="cmdidRed" value="0x102"/>
    <IDSymbol name="cmdidYellow" value="0x103"/>
    <IDSymbol name="cmdidBlue" value="0x104"/>
</GuidSymbol>

Poco prima dell'elemento Buttons, creare un elemento Menus e quindi definirne il menu di scelta rapida.

<Menus>
  <Menu guid="guidShortcutMenuPackageCmdSet" id="ColorMenu" type="Context">
    <Strings>
      <ButtonText>Color change</ButtonText>
      <CommandName>ColorChange</CommandName>
    </Strings>
  </Menu>
</Menus>

Un menu di scelta rapida non ha un elemento padre perché non fa parte di un menu o di una barra degli strumenti.

Creare un elemento Groups con un elemento Group che contiene le voci di menu di scelta rapida e associare il gruppo al menu di scelta rapida.

<Groups>
    <Group guid="guidShortcutMenuPackageCmdSet" id="ColorGroup">
        <Parent guid="guidShortcutMenuPackageCmdSet" id="ColorMenu"/>
    </Group>
</Groups>

Nell'elemento Buttons definire i singoli comandi che verranno visualizzati nel menu di scelta rapida. L'elemento Buttons dovrebbe essere simile al seguente:

<Buttons>
    <Button guid="guidShortcutMenuPackageCmdSet" id="ShortcutMenuCommandId" priority="0x0100" type="Button">
        <Parent guid="guidSHLMainMenu" id="IDG_VS_WNDO_OTRWNDWS1"/>
        <Icon guid="guidImages" id="bmpPic1" />
        <Strings>
            <ButtonText>ShortcutMenu</ButtonText>
        </Strings>
    </Button>

    <Button guid="guidShortcutMenuPackageCmdSet" id="cmdidRed" priority="1" type="Button">
        <Parent guid="guidShortcutMenuPackageCmdSet" id="ColorGroup" />
        <Strings>
            <ButtonText>Red</ButtonText>
        </Strings>
    </Button>

    <Button guid="guidShortcutMenuPackageCmdSet" id="cmdidYellow" priority="3" type="Button">
        <Parent guid="guidShortcutMenuPackageCmdSet" id="ColorGroup" />
        <Strings>
            <ButtonText>Yellow</ButtonText>
        </Strings>
    </Button>

    <Button guid="guidShortcutMenuPackageCmdSet" id="cmdidBlue" priority="5" type="Button">
        <Parent guid="guidShortcutMenuPackageCmdSet" id="ColorGroup" />
        <Strings>
            <ButtonText>Blue</ButtonText>
        </Strings>
    </Button>
</Buttons>

In ShortcutMenuCommand.cs aggiungere le definizioni per il GUID del set di comandi, il menu di scelta rapida e le voci di menu.
```
public const string guidShortcutMenuPackageCmdSet = "00000000-0000-0000-0000-00000000"; // your GUID will differ
public const int ColorMenu = 0x1000;
public const int cmdidRed = 0x102;
public const int cmdidYellow = 0x103;
public const int cmdidBlue = 0x104;
```
Si tratta degli stessi ID comando definiti nella sezione Simboli del file ShortcutMenuPackage.vsct . Il gruppo di contesto non è incluso qui perché è necessario solo nel file con estensione vsct .

Questa sezione implementa il menu di scelta rapida e i relativi comandi.

In ShortcutMenu.cs la finestra degli strumenti può ottenere il servizio comandi di menu, ma il controllo che contiene non può. I passaggi seguenti illustrano come rendere disponibile il servizio comandi di menu per il controllo utente.

In ShortcutMenu.cs aggiungere le direttive using seguenti:

using Microsoft.VisualStudio.Shell;
using System.ComponentModel.Design;

Eseguire l'override del metodo Initialize() della finestra degli strumenti per ottenere il servizio comandi di menu e aggiungere il controllo, passando il servizio comandi di menu al costruttore:
```
protected override void Initialize()
{
    var commandService = (OleMenuCommandService)GetService(typeof(IMenuCommandService));
    Content = new ShortcutMenuControl(commandService);
}
```
Nel costruttore della finestra degli strumenti ShortcutMenu rimuovere la riga che aggiunge il controllo. Il costruttore dovrebbe ora essere simile al seguente:
```
public ShortcutMenu() : base(null)
{
    this.Caption = "ShortcutMenu";
    this.BitmapResourceID = 301;
    this.BitmapIndex = 1;
}
```

In ShortcutMenuControl.xaml.cs aggiungere un campo privato per il servizio comandi di menu e modificare il costruttore del controllo per accettare il servizio comandi di menu. Usare quindi il servizio comandi di menu per aggiungere i comandi di menu di scelta rapida. Il costruttore ShortcutMenuControl dovrebbe ora essere simile al codice seguente. Il gestore dei comandi verrà definito in un secondo momento.

public ShortcutMenuControl(OleMenuCommandService service)
{
    this.InitializeComponent();
    commandService = service;

    if (null !=commandService)
    {
        // Create an alias for the command set guid.
        Guid guid = new Guid(ShortcutMenuCommand.guidShortcutMenuPackageCmdSet);

        // Create the command IDs.
        var red = new CommandID(guid, ShortcutMenuCommand.cmdidRed);
        var yellow = new CommandID(guid, ShortcutMenuCommand.cmdidYellow);
        var blue = new CommandID(guid, ShortcutMenuCommand.cmdidBlue);

        // Add a command for each command ID.
        commandService.AddCommand(new MenuCommand(ChangeColor, red));
        commandService.AddCommand(new MenuCommand(ChangeColor, yellow));
        commandService.AddCommand(new MenuCommand(ChangeColor, blue));
    }
}

In ShortcutMenuControl.xaml aggiungere un MouseRightButtonDown evento all'elemento di primo livello UserControl . Il file XAML dovrebbe ora essere simile al seguente:

<UserControl x:Class="TWShortcutMenu.ShortcutMenuControl"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        Background="{DynamicResource VsBrush.Window}"
        Foreground="{DynamicResource VsBrush.WindowText}"
        mc:Ignorable="d"
        d:DesignHeight="300" d:DesignWidth="300"
        Name="MyToolWindow"
        MouseRightButtonDown="MyToolWindow_MouseRightButtonDown">
    <Grid>
        <StackPanel Orientation="Vertical">
            <TextBlock Margin="10" HorizontalAlignment="Center">ShortcutMenu</TextBlock>
        </StackPanel>
    </Grid>
</UserControl>

In ShortcutMenuControl.xaml.cs aggiungere uno stub per il gestore eventi.

private void MyToolWindow_MouseRightButtonDown(object sender, MouseButtonEventArgs e)
{
. . .
}

Aggiungere le direttive using seguenti allo stesso file:

using Microsoft.VisualStudio.Shell;
using System.ComponentModel.Design;
using System;
using System.Windows.Input;
using System.Windows.Media;

Implementare l'evento MyToolWindowMouseRightButtonDown come indicato di seguito.

private void MyToolWindow_MouseRightButtonDown(object sender, MouseButtonEventArgs e)
{
    if (null != commandService)
    {
        CommandID menuID = new CommandID(
            new Guid(ShortcutMenuCommand.guidShortcutMenuPackageCmdSet),
            ShortcutMenuCommand.ColorMenu);
        Point p = this.PointToScreen(e.GetPosition(this));
        commandService.ShowContextMenu(menuID, (int)p.X, (int)p.Y);
    }
}

In questo modo viene creato un CommandID oggetto per il menu di scelta rapida, viene identificata la posizione del clic del mouse e viene aperto il menu di scelta rapida in tale posizione usando il ShowContextMenu metodo .

Implementare il gestore dei comandi.

private void ChangeColor(object sender, EventArgs e)
{
    var mc = sender as MenuCommand;

    switch (mc.CommandID.ID)
    {
        case ShortcutMenuCommand.cmdidRed:
            MyToolWindow.Background = Brushes.Red;
            break;
        case ShortcutMenuCommand.cmdidYellow:
            MyToolWindow.Background = Brushes.Yellow;
            break;
        case ShortcutMenuCommand.cmdidBlue:
            MyToolWindow.Background = Brushes.Blue;
            break;
    }
}

In questo caso, solo un metodo gestisce gli eventi per tutte le voci di menu identificando e CommandID impostando di conseguenza il colore di sfondo. Se le voci di menu avevano comandi non correlati, è stato creato un gestore eventi separato per ogni comando.

Testare le funzionalità della finestra degli strumenti

Compilare il progetto e avviare il debug. Viene visualizzata l'istanza sperimentale.
Nell'istanza sperimentale fare clic su Visualizza/Altre finestre e quindi su CollegamentoMenu. In questo modo verrà visualizzata la finestra degli strumenti.
Fare clic con il pulsante destro del mouse nel corpo della finestra degli strumenti. Verrà visualizzato un menu di scelta rapida con un elenco di colori.
Fare clic su un colore nel menu di scelta rapida. Il colore di sfondo della finestra degli strumenti deve essere modificato nel colore selezionato.

Aggiungere un menu di scelta rapida in una finestra degli strumenti

Creare il pacchetto di menu di scelta rapida della finestra degli strumenti

Specifica del menu di scelta rapida

Implementazione del menu di scelta rapida

Testare le funzionalità della finestra degli strumenti

Risorse aggiuntive

Aggiungere un menu di scelta rapida in una finestra degli strumenti

Creare il pacchetto di menu di scelta rapida della finestra degli strumenti

Specifica del menu di scelta rapida

Implementazione del menu di scelta rapida

Testare le funzionalità della finestra degli strumenti

Contenuto correlato

Risorse aggiuntive