リモート UI と VisualStudio.Extensibility SDK を使用して、データ バインド UI を含むドッキング可能なツール ウィンドウを作成します。
Note
このガイドでは、 VisualStudio.Extensibility SDK を使用します。 モデルの比較については、「適切な拡張モデルの選択」を参照してください。
完全な例
完全な実装:
ツールウィンドウの定義:
// 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));
}
}
ツールウィンドウを開くコマンド:
// 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
完全に動作するサンプル (ToolWindowSample ↗) を参照
関連する概念:リモート UI — ツール ウィンドウのコンテンツに使用されるデータ バインディング モデル、コントリビューション、および構成 — ツール ウィンドウのコントリビューションの宣言方法
例を理解しましょう
ステップ 1: ツールウィンドウ クラスを定義する
ToolWindowを拡張し、[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!));
}
}
手順 2: データ モデルを作成する
リモート UI のデータ バインディングには、[DataContract] を [DataMember] および NotifyPropertyChangedObject とともに使用します:
[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
}
}
手順 3: リモート UI コントロールを作成する
RemoteUserControl クラスと一致する XAML データ テンプレートを追加します。
MyToolWindowControl.cs:
internal class MyToolWindowControl : RemoteUserControl
{
public MyToolWindowControl(MyDataModel dataModel)
: base(dataContext: dataModel)
{
}
}
MyToolWindowControl.xaml — ビルド アクションを EmbeddedResource(Page ではなく)に設定します。
<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
XAML ファイルでは、EmbeddedResource ビルド アクションを使用する必要があります。
Page に設定すると、ツール ウィンドウが空になります。
手順 4: ツール ウィンドウを表示するコマンドを追加する
[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);
}
}
手順 5 (省略可能): ツールバーを追加
ツール バーを定義し、 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
- XAML ファイルを EmbeddedResource ビルド アクションとしてマークします (ページではありません)。
- リモート UI の ViewModel プロパティで
[DataContract]と[DataMember]を使用します。 - データ モデルのベースとして
NotifyPropertyChangedObjectを使用します。 -
InitializeAsync()でデータを初期化し、GetContentAsync()でUIを作成します。 -
ShowToolWindowAsync<T>(activate: true)を使用してコマンドから表示します。
❌ 禁止事項
- WPFを直接使用しないでください。アウトプロセス拡張機能にはリモート UI が必要です。
- XAML ビルド アクションを
Pageに設定しないでください (ツール ウィンドウはレンダリングされません)。 - コンストラクターに高価なリソースを作成しないでください。
InitializeAsyncを使用してください。
🔧 トラブルシューティング
| 症状: | 修正 |
|---|---|
| ツールウィンドウが空です | XAML ビルド アクションが EmbeddedResource であることを確認してください |
| データ バインディングが更新されない | ViewModel が NotifyPropertyChangedObject を継承し、プロパティが [DataMember] を持つことを確認してください |
| ウィンドウが表示されない | コマンドで ShowToolWindowAsync が正しく呼び出されていることを確認する |
| ツールバーが表示されない |
ToolWindowConfiguration.Toolbarが設定されていることを確認する |
次のステップ
- リモート UI の概要 - レンダリング モデルを理解する
- コマンドの追加 — ツール ウィンドウを開くため
- テーマと色 — UI をカスタマイズ