[プロパティ] ウィンドウにプロパティを表示する

[アーティクル]
11/15/2023

このチュートリアルでは、オブジェクトのパブリックプロパティを [プロパティ] ウィンドウに表示します。これらのプロパティに加えた変更は、[プロパティ] ウィンドウに反映されます。

[プロパティ] ウィンドウにプロパティを表示する

このセクションでは、カスタムツールウィンドウを作成し、関連付けられているウィンドウペインオブジェクトのパブリックプロパティを [プロパティ] ウィンドウに表示します。

[プロパティ] ウィンドウにプロパティを表示するには

すべての Visual Studio 拡張機能は、拡張機能アセットを格納する VSIX デプロイプロジェクトから始まります。 MyObjectPropertiesExtension という名前の Visual Studio VSIX プロジェクトを作成します。 VSIX プロジェクトテンプレートは、[新しいプロジェクト] ダイアログで「vsix」と検索すると見つかります。
MyToolWindow という名前のカスタムツールウィンドウ項目テンプレートを追加して、ツールウィンドウを追加します。 ソリューションエクスプローラーで、プロジェクトノードを右クリックして、[追加]>[新しい項目] の順に選択します。 [新しい項目の追加] ダイアログで、[Visual C# 項目]>[機能拡張] の順にアクセスし、[カスタムツールウィンドウ] を選択します。ダイアログの下部にある [名前] フィールドで、ファイル名を MyToolWindow.cs に変更します。カスタムツールウィンドウの作成方法について詳しくは、「ツールウィンドウで拡張機能を作成する」をご覧ください。

MyToolWindow.cs を開いて、次の using ステートメントを追加します。

using System.Collections;
using System.ComponentModel;
using Microsoft.VisualStudio.Shell.Interop;

MyToolWindow クラスに次のフィールドを追加します。

private ITrackSelection trackSel;
private SelectionContainer selContainer;

MyToolWindow クラスに次のコードを追加します。

private ITrackSelection TrackSelection
{
    get
    {
        if (trackSel == null)
            trackSel =
               GetService(typeof(STrackSelection)) as ITrackSelection;
        return trackSel;
    }
}

public void UpdateSelection()
{
    ITrackSelection track = TrackSelection;
    if (track != null)
        track.OnSelectChange((ISelectionContainer)selContainer);
}

public void SelectList(ArrayList list)
{
    selContainer = new SelectionContainer(true, false);
    selContainer.SelectableObjects = list;
    selContainer.SelectedObjects = list;
    UpdateSelection();
}

public override void OnToolWindowCreated()
{
    ArrayList listObjects = new ArrayList();
    listObjects.Add(this);
    SelectList(listObjects);
}

TrackSelection プロパティでは、GetService を使用して STrackSelection サービスを取得します。これによって、ITrackSelection インターフェイスが提供されます。 OnToolWindowCreated イベントハンドラーと SelectList メソッドを一緒に使用すると、ツールウィンドウペインオブジェクト自体だけが含まれる、選択したオブジェクトのリストが作成されます。 UpdateSelection メソッドによって、ツールウィンドウペインのパブリックプロパティを表示するように、[プロパティ] ウィンドウに通知されます。

プロジェクトをビルドし、デバッグを開始します。 Visual Studio の実験用インスタンスが表示されます。
[プロパティ] ウィンドウが表示されない場合は、F4 キーを押して開きます。
[MyToolWindow] ウィンドウを開きます。 [ビュー]>[その他のウィンドウ] で見つけることができます。

ウィンドウが開き、[プロパティ] ウィンドウにウィンドウペインのパブリックプロパティが表示されます。
[プロパティ] ウィンドウの [キャプション] プロパティを [マイオブジェクトのプロパティ] に変更します。

[MyToolWindow] ウィンドウのキャプションが、それに応じて変更されます。

ツールウィンドウのプロパティを表示する

このセクションでは、ツールウィンドウを追加し、そのプロパティを表示します。プロパティに加えた変更は、[プロパティ] ウィンドウに反映されます。

ツールウィンドウのプロパティを表示するには

MyToolWindow.cs を開き、パブリックブール型プロパティ IsChecked を MyToolWindow クラスに追加します。

[Category("My Properties")]
[Description("MyToolWindowControl properties")]
public bool IsChecked
{
    get {
        if (base.Content == null)  return false;
        return (bool)(( MyToolWindowControl) base.Content).checkBox.IsChecked;
    }
    set {
        ((MyToolWindowControl) base.Content).checkBox.IsChecked = value;
    }
}

このプロパティでは、後で作成する WPF チェックボックスから状態を取得します。

MyToolWindowControl.xaml.cs を開き、MyToolWindowControl コンストラクターを次のコードに置き換えます。
```
private MyToolWindow pane;
public MyToolWindowControl(MyToolWindow pane)
{
    InitializeComponent();
    this.pane = pane;
    checkBox.IsChecked = false;
}
```
これにより、MyToolWindowControl で MyToolWindow ペインにアクセスできるようになります。
MyToolWindow.cs で、次のように MyToolWindow コンストラクターを変更します。
```
base.Content = new MyToolWindowControl(this);
```
MyToolWindowControl のデザインビューに変更します。
ボタンを削除し、ツールボックスから左上隅にチェックボックスを追加します。
Checked および Unchecked イベントを追加します。デザインビューでチェックボックスをオンにします。 [プロパティ] ウィンドウで、イベントハンドラーボタン ([プロパティ] ウィンドウの右上) をクリックします。 [Checked] を見つけて、テキストボックスに「checkbox_Checked」と入力し、[Unchecked] を見つけて、テキストボックスに「checkbox_Unchecked」と入力します。

チェックボックスのイベントハンドラーを追加します。

private void checkbox_Checked(object sender, RoutedEventArgs e)
{
    pane.IsChecked = true;
    pane.UpdateSelection();
}
private void checkbox_Unchecked(object sender, RoutedEventArgs e)
{
    pane.IsChecked = false;
    pane.UpdateSelection();
}

プロジェクトをビルドし、デバッグを開始します。
実験用インスタンスで、[MyToolWindow] ウィンドウを開きます。

[プロパティ] ウィンドウで、ウィンドウのプロパティを探します。 [IsChecked] プロパティは、ウィンドウの下部の [マイプロパティ] カテゴリの下に表示されます。
[MyToolWindow] ウィンドウのチェックボックスをオンにします。 [プロパティ] ウィンドウの [IsChecked] が True に変更されます。 [MyToolWindow] ウィンドウのチェックボックスをクリアします。 [プロパティ] ウィンドウの [IsChecked] が False に変更されます。 [プロパティ] ウィンドウの [IsChecked] の値を変更します。 [MyToolWindow] ウィンドウのチェックボックスが、新しい値と一致するように変更されます。

Note

[プロパティ] ウィンドウに表示されるオブジェクトを破棄する必要がある場合は、null 選択コンテナーを先頭にして OnSelectChange を呼び出します。プロパティまたはオブジェクトを破棄したら、更新された SelectableObjects および SelectedObjects リストがある選択コンテナーに変更できます。

選択リストを変更する

このセクションでは、基本プロパティクラスの選択リストを追加し、ツールウィンドウインターフェイスを使用して、表示する選択リストを選択します。

選択リストを変更するには

MyToolWindow.cs を開いて、Simple という名前のパブリッククラスを追加します。

public class Simple
{
    private string someText = "";

    [Category("My Properties")]
    [Description("Simple Properties")]
    [DisplayName("My Text")]
    public string SomeText
    {
        get { return someText; }
        set { someText = value; }
    }

    [Category("My Properties")]
    [Description("Read-only property")]
    public bool ReadOnly
    {
        get { return false; }
    }
}

MyToolWindow クラスに SimpleObject プロパティと 2 つのメソッドを追加します。これらのメソッドでは、ウィンドウペインと Simple オブジェクトの間で [プロパティ] ウィンドウの選択を切り替えます。

private Simple simpleObject = null;
public Simple SimpleObject
{
    get
    {
        if (simpleObject == null) simpleObject = new Simple();
        return simpleObject;
    }
}

public void SelectSimpleList()
{
    ArrayList listObjects = new ArrayList();
    listObjects.Add(SimpleObject);
    SelectList(listObjects);
}

public void SelectThisList()
{
    ArrayList listObjects = new ArrayList();
    listObjects.Add(this);
    SelectList(listObjects);
}

MyToolWindowControl.cs で、チェックボックスのハンドラーを次のコード行に置き換えます。

private void checkbox_Checked(object sender, RoutedEventArgs e)
 {
    pane.IsChecked = true;
    pane.SelectSimpleList();
    pane.UpdateSelection();
}
private void checkbox_Unchecked(object sender, RoutedEventArgs e)
{
    pane.IsChecked = false;
    pane.SelectThisList();
    pane.UpdateSelection();
}

プロジェクトをビルドし、デバッグを開始します。
実験用インスタンスで、[MyToolWindow] ウィンドウを開きます。
[MyToolWindow] ウィンドウのチェックボックスを選択します。 [プロパティ] ウィンドウには、Simple オブジェクトのプロパティ ([SomeText] と [ReadOnly]) が表示されます。チェックボックスをオフにするウィンドウのパブリックプロパティが [プロパティ] ウィンドウに表示されます。

Note

[SomeText] の表示名は [My Text] です。

ベストプラクティス

このチュートリアルでは、選択可能なオブジェクトコレクションと選択されたオブジェクトコレクションが同じコレクションになるように、ISelectionContainer が実装されます。選択されたオブジェクトのみが [プロパティブラウザー] の一覧に表示されます。 ISelectionContainer の実装の詳細については、Reference.ToolWindow のサンプルを参照してください。

Visual Studio のツールウィンドウは、Visual Studio のセッション間で保持されます。ツールウィンドウの状態の保持の詳細については、ProvideProfileAttribute を参照してください。

プロパティとプロパティウィンドウを拡張する

[プロパティ] ウィンドウにプロパティを表示する

[プロパティ] ウィンドウにプロパティを表示する

[プロパティ] ウィンドウにプロパティを表示するには

ツール ウィンドウのプロパティを表示する

ツール ウィンドウのプロパティを表示するには

選択リストを変更する

選択リストを変更するには

ベスト プラクティス

関連するコンテンツ

その他のリソース

ツールウィンドウのプロパティを表示する

ツールウィンドウのプロパティを表示するには

ベストプラクティス