Toolfenster

Erstellen Sie ein dockbares Toolfenster mit datengebundener Benutzeroberfläche mithilfe der Remote-UI und des VisualStudio.Extensibility SDK.

Note

In diesem Handbuch wird das VisualStudio.Extensibility SDK verwendet. Informationen zum Modellvergleich finden Sie unter Auswählen des richtigen Erweiterbarkeitsmodells.

Vollständiges Beispiel

Die vollständige Implementierung:

Toolfensterdefinition:

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

namespace ToolWindowSample;

using System.Threading;
using System.Threading.Tasks;
using Microsoft.VisualStudio.Extensibility;
using Microsoft.VisualStudio.Extensibility.Commands;
using Microsoft.VisualStudio.Extensibility.ToolWindows;
using Microsoft.VisualStudio.RpcContracts.RemoteUI;

/// <summary>
/// A sample tool window.
/// </summary>
[VisualStudioContribution]
public class MyToolWindow : ToolWindow
{
    private object? dataContext;

    /// <summary>
    /// Initializes a new instance of the <see cref="MyToolWindow" /> class.
    /// </summary>
    public MyToolWindow()
    {
        this.Title = "My Tool Window";
    }

    /// <inheritdoc />
    public override ToolWindowConfiguration ToolWindowConfiguration => new()
    {
        Placement = ToolWindowPlacement.DocumentWell,
        Toolbar = new ToolWindowToolbar(Toolbar),
    };

    [VisualStudioContribution]
    private static ToolbarConfiguration Toolbar => new("%ToolWindowSample.MyToolWindow.Toolbar.DisplayName%")
    {
        Children = [ToolbarChild.Command<MyToolbarCommand>()],
    };

    /// <inheritdoc />
    public override Task InitializeAsync(CancellationToken cancellationToken)
    {
        this.dataContext = new MyToolWindowData(this.Extensibility);

        return Task.CompletedTask;
    }

    /// <inheritdoc />
    public override Task<IRemoteUserControl> GetContentAsync(CancellationToken cancellationToken)
    {
        return Task.FromResult<IRemoteUserControl>(new MyToolWindowControl(this.dataContext));
    }
}

Der Befehl zum Öffnen des Toolfensters:

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

namespace ToolWindowSample;

using System.Threading;
using System.Threading.Tasks;
using Microsoft.VisualStudio.Extensibility;
using Microsoft.VisualStudio.Extensibility.Commands;

/// <summary>
/// A sample command for showing a tool window.
/// </summary>
[VisualStudioContribution]
public class MyToolWindowCommand : Command
{
    /// <inheritdoc />
    public override CommandConfiguration CommandConfiguration => new("%ToolWindowSample.MyToolWindowCommand.DisplayName%")
    {
        Placements = [CommandPlacement.KnownPlacements.ToolsMenu],
        Icon = new(ImageMoniker.KnownValues.ToolWindow, IconSettings.IconAndText),
    };

    /// <inheritdoc />
    public override async Task ExecuteCommandAsync(IClientContext context, CancellationToken cancellationToken)
    {
        await this.Extensibility.Shell().ShowToolWindowAsync<MyToolWindow>(activate: true, cancellationToken);
    }
}

Tip

Sehen Sie sich das vollständige Arbeitsbeispiel an: ToolWindowSample ↗

Verwandte Konzepte:Remote-UI – das Datenbindungsmodell, das für Toolfensterinhalte, Beiträge und Konfigurationen verwendet wird – wie Toolfensterbeiträge deklariert werden

Verstehen des Beispiels

Schritt 1: Definieren der Toolfensterklasse

Erweitern Sie ToolWindow und markieren Sie es mit [VisualStudioContribution]:

[VisualStudioContribution]
internal class MyToolWindow : ToolWindow
{
    private MyDataModel? dataModel;

    public MyToolWindow(VisualStudioExtensibility extensibility)
        : base(extensibility)
    {
        Title = "My Tool Window";
    }

    public override ToolWindowConfiguration ToolWindowConfiguration => new()
    {
        Placement = ToolWindowPlacement.DocumentWell,
        AllowAutoCreation = true,
    };

    public override async Task InitializeAsync(CancellationToken cancellationToken)
    {
        dataModel = new MyDataModel();
        await dataModel.LoadAsync(cancellationToken);
    }

    public override Task<IRemoteUserControl> GetContentAsync(CancellationToken cancellationToken)
    {
        return Task.FromResult<IRemoteUserControl>(new MyToolWindowControl(dataModel!));
    }
}

Schritt 2: Erstellen des Datenmodells

Verwenden Sie NotifyPropertyChangedObject mit [DataContract] und [DataMember] für Remote-UI-Datenbindung:

[DataContract]
internal class MyDataModel : NotifyPropertyChangedObject
{
    private string message = "Hello from the tool window!";

    [DataMember]
    public string Message
    {
        get => message;
        set => SetProperty(ref message, value);
    }

    public async Task LoadAsync(CancellationToken cancellationToken)
    {
        // Load data asynchronously
    }
}

Schritt 3: Erstellen des Remote-UI-Steuerelements

Fügen Sie eine RemoteUserControl Klasse und eine entsprechende XAML-Datenvorlage hinzu.

MyToolWindowControl.cs:

internal class MyToolWindowControl : RemoteUserControl
{
    public MyToolWindowControl(MyDataModel dataModel)
        : base(dataContext: dataModel)
    {
    }
}

MyToolWindowControl.xaml – Build-Aktion auf EmbeddedResource festlegen (nicht Seite):

<DataTemplate xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
              xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
              xmlns:vs="http://schemas.microsoft.com/visualstudio/extensibility/2022/xaml">
    <StackPanel Margin="10">
        <TextBlock Text="{Binding Message}" FontSize="14" />
    </StackPanel>
</DataTemplate>

Important

Die XAML-Datei muss die EmbeddedResource Buildaktion verwenden. Wenn Sie es auf Page festlegen, wird das Toolfenster leer gerendert.

Schritt 4: Hinzufügen eines Befehls zum Anzeigen des Toolfensters

[VisualStudioContribution]
internal class ShowMyToolWindowCommand : Command
{
    public ShowMyToolWindowCommand(VisualStudioExtensibility extensibility)
        : base(extensibility)
    {
    }

    public override CommandConfiguration CommandConfiguration => new("My Tool Window")
    {
        Placements = [CommandPlacement.KnownPlacements.ViewOtherWindowsMenu],
        Icon = new(ImageMoniker.KnownValues.ToolWindow, IconSettings.IconAndText),
    };

    public override async Task ExecuteCommandAsync(IClientContext context, CancellationToken cancellationToken)
    {
        await Extensibility.Shell().ShowToolWindowAsync<MyToolWindow>(activate: true, cancellationToken);
    }
}

Schritt 5 (optional): Symbolleiste hinzufügen

Definieren Sie eine Symbolleiste, und verweisen Sie darauf in ToolWindowConfiguration:

[VisualStudioContribution]
public static ToolbarConfiguration MyToolbar => new("%MyToolbar.DisplayName%")
{
    Children = [
        ToolbarChild.Command<RefreshCommand>(),
        ToolbarChild.Separator,
        ToolbarChild.Command<ClearCommand>(),
    ],
};

public override ToolWindowConfiguration ToolWindowConfiguration => new()
{
    Placement = ToolWindowPlacement.DocumentWell,
    Toolbar = new(MyToolbar),
};

Tips

✅ DO

  • Kennzeichnen Sie XAML-Dateien als EmbeddedResource-Build-Aktion (nicht als Seite).
  • Verwenden Sie [DataContract] und [DataMember] auf ViewModel-Eigenschaften für Remote-UI.
  • Verwenden Sie NotifyPropertyChangedObject als Basis für Datenmodelle.
  • Daten in InitializeAsync() initialisieren, Benutzeroberfläche in GetContentAsync() erstellen.
  • Verwenden Sie ShowToolWindowAsync<T>(activate: true) zum Anzeigen von Befehlen.

❌ NICHT

  • Verwenden Sie WPF nicht direkt – für Out-of-Process-Erweiterungen ist Remote UI erforderlich.
  • Legen Sie die XAML-Buildaktion nicht auf Page fest (das Toolfenster wird nicht gerendert).
  • Erstellen Sie keine teuren Ressourcen im Konstruktor – verwenden Sie InitializeAsync.

🔧 Problembehandlung

Symptom Beheben
Das Toolfenster ist leer. Überprüfen Sie, ob die XAML-Buildaktion EmbeddedResource ist
Die Datenbindung wird nicht aktualisiert. Stellen Sie sicher, dass das ViewModel von NotifyPropertyChangedObject erbt und dass Eigenschaften über [DataMember] verfügen.
Fenster wird nicht angezeigt Befehlsaufrufe ShowToolWindowAsync korrekt überprüfen
Symbolleiste wird nicht angezeigt Stellen Sie sicher, dass ToolWindowConfiguration.Toolbar festgelegt ist

Nächste Schritte