チュートリアル : C# でビジュアライザーを記述する

[アーティクル]
02/21/2013

このチュートリアルでは、C# を使用して簡単なビジュアライザーを作成する方法を説明します。このチュートリアルで作成するビジュアライザーは、Windows フォームメッセージボックスを使用して文字列の内容を表示します。この簡単な文字列ビジュアライザーは、それ自体ではそれほど役に立ちませんが、他のデータ型を表示する、より役に立つビジュアライザーを作成するために必要な基本手順として使用できます。

[!メモ]

使用している設定またはエディションによっては、ヘルプの記載と異なるダイアログボックスやメニューコマンドが表示される場合があります。設定を変更するには、[ツール] メニューの [設定のインポートとエクスポート] をクリックします。詳細については、「Visual Studio の設定」を参照してください。

ビジュアライザーコードは、デバッガーによって読み取られる DLL に配置する必要があります。このため、最初の手順として、DLL のクラスライブラリプロジェクトを作成します。

クラスライブラリプロジェクトを作成するには

[ファイル] メニューの [新規作成] をポイントし、[新しいプロジェクト] をクリックします。
[新しいプロジェクト] ダイアログボックスの [プロジェクトの種類] で、[Visual C#] をクリックします。
[テンプレート] ボックスで、[クラスライブラリ] をクリックします。
[プロジェクト名] ボックスに、クラスライブラリの名前 (MyFirstVisualizer など) を入力します。
[OK] をクリックします。

クラスライブラリを作成したら、Microsoft.VisualStudio.DebuggerVisualizers.DLL への参照を追加し、この DLL で定義されているクラスを使用できるようにします。ただし、参照を追加する前に、クラス名をわかりやすい名前に変更する必要があります。

Class1.cs の名前を変更し Microsoft.VisualStudio.DebuggerVisualizers を追加するには

ソリューションエクスプローラーで、Class1.cs を右クリックし、ショートカットメニューの [名前の変更] をクリックします。
Class1.cs の名前を、DebuggerSide.cs などのわかりやすい名前に変更します。

[!メモ]

Visual Studio によって、新しいファイル名に合わせて DebuggerSide.cs のクラス宣言が自動的に変更されます。
ソリューションエクスプローラーで、[参照] を右クリックし、ショートカットメニューの [参照の追加] をクリックします。
[参照の追加] ダイアログボックスの [.NET] タブで、Microsoft.VisualStudio.DebuggerVisualizers.DLL をクリックします。
[OK] をクリックします。
DebuggerSide.cs の using ステートメントに次のステートメントを追加します。
```
using Microsoft.VisualStudio.DebuggerVisualizers;
```

これで、デバッガー側のコードを作成する準備が整いました。これは、視覚化を要する情報を表示するためにデバッガー内で実行されるコードです。最初に、DebuggerSide オブジェクトの宣言を変更して、DialogDebuggerVisualizer 基本クラスを継承するようにする必要があります。

DialogDebuggerVisualizer から継承するには

DebuggerSide.cs で、次のコード行に移動します。
```
public class DebuggerSide
```

コードを次のように変更します。

public class DebuggerSide : DialogDebuggerVisualizer

DialogDebuggerVisualizer には、オーバーライドする必要がある抽象メソッドが 1 つ (Show) があります。

DialogDebuggerVisualizer.Show メソッドをオーバーライドするには

public class DebuggerSide に、次のメソッドを追加します。

override protected void Show(IDialogVisualizerService windowService, IVisualizerObjectProvider objectProvider)
{
}

Show メソッドには、ビジュアライザーのダイアログボックス (または他のユーザーインターフェイス) を実際に作成し、デバッガーからビジュアライザーに渡された情報を表示するコードが格納されます。したがって、このダイアログボックスを作成し、情報を表示するコードを追加する必要があります。このチュートリアルでは、Windows フォームメッセージボックスを使用します。最初に、System.Windows.Forms の参照と using ステートメントを追加する必要があります。

System.Windows.Forms を追加するには

ソリューションエクスプローラーで、[参照] を右クリックし、ショートカットメニューの [参照の追加] をクリックします。
[参照の追加] ダイアログボックスの [.NET] タブで、System.Windows.Forms.DLL をクリックします。
[OK] をクリックします。
DebuggerSide.cs の using ステートメントに次のステートメントを追加します。
```
using System.Windows.Forms;
```

次に、ビジュアライザーのインターフェイスを作成し、表示するコードを追加します。これは、初めて作成するビジュアライザーであるため、ユーザーインターフェイスを簡素にし、メッセージボックスを使用します。

ビジュアライザーの出力をダイアログボックスに表示するには

Show メソッドに次のコード行を追加します。
```
MessageBox.Show(objectProvider.GetObject().ToString());
```
このコード例には、エラー処理が含まれていません。実際に使用するビジュアライザーや、どのようなアプリケーションにも、エラー処理を追加する必要があります。
[ビルド] メニューの [MyFirstVisualizer のビルド] をクリックします。プロジェクトが構築されます。ビルドエラーを修正してから次の作業に進みます。

これで、デバッガー側のコードは終わりです。ただし、もう 1 つ追加するものがあります。それは、ビジュアライザーを構成しているクラスのコレクションをデバッグ対象側に通知する属性です。

デバッグ対象側のコードを追加するには

DebuggerSide.cs の using ステートメントと namespace MyFirstVisualizer の間に次の属性コードを追加します。

[assembly:System.Diagnostics.DebuggerVisualizer(
typeof(MyFirstVisualizer.DebuggerSide),
typeof(VisualizerObjectSource),
Target  = typeof(System.String),
Description  = "My First Visualizer")]

[ビルド] メニューの [MyFirstVisualizer のビルド] をクリックします。プロジェクトが構築されます。ビルドエラーを修正してから次の作業に進みます。

これで、最初のビジュアライザーが完成しました。手順どおりに作業を行ってきた場合は、ビジュアライザーを構築し、Visual Studio にインストールできます。ただし、ビジュアライザーを Visual Studio にインストールする前にテストを行い、ビジュアライザーが正しく動作することを確認する必要があります。そこで、Visual Studio にインストールしないでビジュアライザーを実行する、テストハーネスを作成します。

ビジュアライザーを表示するテストメソッドを追加するには

次のメソッドを public DebuggerSide クラスに追加します。

public static void TestShowVisualizer(object objectToVisualize)
{
   VisualizerDevelopmentHost visualizerHost = new VisualizerDevelopmentHost(objectToVisualize, typeof(DebuggerSide));
   visualizerHost.ShowVisualizer();
}

[ビルド] メニューの [MyFirstVisualizer のビルド] をクリックします。プロジェクトが構築されます。ビルドエラーを修正してから次の作業に進みます。

次に、ビジュアライザー DLL を呼び出す実行可能プロジェクトを作成する必要があります。わかりやすくするために、コンソールアプリケーションプロジェクトを使用します。

ソリューションにコンソールアプリケーションプロジェクトを追加するには

[ファイル] メニューの [追加] をポイントし、[新しいプロジェクト] をクリックします。
[新しいプロジェクト] ダイアログボックスの [テンプレート] ボックスで、[コンソールアプリケーション] をクリックします。
[プロジェクト名] ボックスに、コンソールアプリケーション用のわかりやすい名前 (MyTestConsole など) を入力します。
[OK] をクリックします。

次に、必要な参照を追加して、MyTestConsole が MyFirstVisualizer を呼び出すことができるようにします。

必要な参照を MyTestConsole に追加するには

ソリューションエクスプローラーで、[MyTestConsole] を右クリックし、ショートカットメニューの [参照の追加] をクリックします。
[参照の追加] ダイアログボックスの [.NET] タブで、Microsoft.VisualStudio.DebuggerVisualizers.DLL をクリックします。
[OK] をクリックします。
MyTestConsole を右クリックし、再度 [参照の追加] をクリックします。
[参照の追加] ダイアログボックスの [プロジェクト] タブをクリックし、MyFirstVisualizer をクリックします。
[OK] をクリックします。

次に、コードを追加してテストハーネスを完成させます。

コードを MyTestConsole に追加するには

ソリューションエクスプローラーで、Program.cs を右クリックし、ショートカットメニューの [名前の変更] をクリックします。
Program.cs の名前を、TestConsole.cs などの、よりわかりやすい名前に変更します。

メモ Visual Studio によって、新しいファイル名に合わせて TestConsole.cs のクラス宣言が自動的に変更されます。
TestConsole.cs の using ステートメントに次のコードを追加します。
```
using MyFirstVisualizer;
```

Main メソッドに、次のコードを追加します。

String myString = "Hello, World";
DebuggerSide.TestShowVisualizer(myString);

これで、作成したビジュアライザーをテストする準備が整いました。

ビジュアライザーをテストするには

ソリューションエクスプローラーで [MyTestConsole] を右クリックし、ショートカットメニューの [スタートアッププロジェクトに設定] をクリックします。
[デバッグ] メニューの [開始] をクリックします。

コンソールアプリケーションが起動してビジュアライザーが表示され、"Hello, World" という文字列が表示されます。

テストは成功です。これで、最初のビジュアライザーの作成とテストが完了しました。

作成したビジュアライザーをテストハーネスから呼び出すのではなく、Visual Studio で使用する場合は、ビジュアライザーをインストールする必要があります。詳細については、「方法 : ビジュアライザーをインストールする」を参照してください。

ビジュアライザー項目テンプレートの使用

このチュートリアルのこれまでの部分では、ビジュアライザーを手動で作成する方法について説明し、これを演習形式で実行しました。簡単なビジュアライザーがどのように動作するかを理解したことを踏まえて、ここでは、ビジュアライザー項目テンプレートを使用して、ビジュアライザーをより簡単に作成する方法を紹介します。

最初に、新しいクラスライブラリプロジェクトを作成する必要があります。

新しいクラスライブラリを作成するには

[ファイル] メニューの [追加] をポイントし、[新しいプロジェクト] をクリックします。
[新しいプロジェクトの追加] ダイアログボックスの [プロジェクトの種類] で、[Visual C#] をクリックします。
[テンプレート] ボックスで、[クラスライブラリ] をクリックします。
[プロジェクト名] ボックスに、クラスライブラリの名前 (MySecondVisualizer など) を入力します。
[OK] をクリックします。

これで、ビジュアライザー項目を追加できます。

ビジュアライザー項目を追加するには

ソリューションエクスプローラーで、[MySecondVisualizer] を右クリックします。
ショートカットメニューの [追加] をクリックし、さらに [新しい項目] をクリックします。
[新しい項目の追加] ダイアログボックスの [テンプレート] の下の [Visual Studio にインストールされたテンプレート] で、[デバッガービジュアライザー] をクリックします。
[ファイル名] ボックスに、名前 (SecondVisualizer.cs など) を入力します。
[追加] をクリックします。

これで作業は完了です。SecondVisualizer.cs ファイルを参照し、テンプレートによって追加されたコードを確認します。さらにコードを実行してみてください。以上で基礎的な項目を習得しました。これで、より複雑で有効な独自のビジュアライザーを作成できます。

参照

次の方法で共有

チュートリアル : C# でビジュアライザーを記述する

クラスライブラリプロジェクトを作成するには

Class1.cs の名前を変更し Microsoft.VisualStudio.DebuggerVisualizers を追加するには

DialogDebuggerVisualizer から継承するには

DialogDebuggerVisualizer.Show メソッドをオーバーライドするには

System.Windows.Forms を追加するには

ビジュアライザーの出力をダイアログボックスに表示するには

デバッグ対象側のコードを追加するには

ビジュアライザーを表示するテストメソッドを追加するには

ソリューションにコンソールアプリケーションプロジェクトを追加するには

必要な参照を MyTestConsole に追加するには

コードを MyTestConsole に追加するには

ビジュアライザーをテストするには

ビジュアライザー項目テンプレートの使用

新しいクラスライブラリを作成するには

ビジュアライザー項目を追加するには

参照

処理手順

概念

その他の技術情報

その他のリソース

次の方法で共有

チュートリアル : C# でビジュアライザーを記述する

クラス ライブラリ プロジェクトを作成するには

Class1.cs の名前を変更し Microsoft.VisualStudio.DebuggerVisualizers を追加するには

DialogDebuggerVisualizer から継承するには

DialogDebuggerVisualizer.Show メソッドをオーバーライドするには

System.Windows.Forms を追加するには

ビジュアライザーの出力をダイアログ ボックスに表示するには

デバッグ対象側のコードを追加するには

ビジュアライザーを表示するテスト メソッドを追加するには

ソリューションにコンソール アプリケーション プロジェクトを追加するには

必要な参照を MyTestConsole に追加するには

コードを MyTestConsole に追加するには

ビジュアライザーをテストするには

ビジュアライザー項目テンプレートの使用

新しいクラス ライブラリを作成するには

ビジュアライザー項目を追加するには

参照

処理手順

概念

その他の技術情報

その他のリソース

クラスライブラリプロジェクトを作成するには

ビジュアライザーの出力をダイアログボックスに表示するには

ビジュアライザーを表示するテストメソッドを追加するには

ソリューションにコンソールアプリケーションプロジェクトを追加するには

新しいクラスライブラリを作成するには