特集：初めてのVisual Studioアドイン（中編） Visual Studioアドインを実装しIDEで使う！ 株式会社NTTデータ 技術開発本部 ソフトウェア工学推進センタ 瀬下 真吾 2009/03/31
Page1 Page2 Page3

●コマンド実行時にXMLファイル編集画面を表示する

　コマンド実行時の「動き」の実装手順は次のとおりです。

1. XMLファイル編集画面を作成する
• XMLファイルの内容をデータグリッドビュー（DataGridViewコントロール）で編集するWindowsフォームを作成します。
• Windowsフォームのコンストラクタや各種イベント処理を実装します
2. コマンド実行時の処理を実装する
• コマンドが実行されたときに1で作成したXMLファイル編集画面を表示する処理を実装します。

○1. XMLファイル編集画面を作成する

　1- SampleAddinプロジェクトにWindowsフォーム（ファイル名：XmlEditor.cs）を追加します。

図1-4 Windowsフォームの追加

　1- Windowsフォームに各コントロールを追加し、図1-5のような画面を作成します。

図1-5 XMLファイル編集画面

以下のコントロールを配置。

No. コントロールの種類 Nameプロパティ Textプロパティ 役割 Label fileNameLabel fileName XMLファイルの名前を表示する DataGridView xmlDataGridView   XMLファイルの内容を表示し、編集する Button saveButton 保存 編集内容をXMLファイルに保存する処理を実行する

　1- Windowsフォームのコンストラクタや各種イベントを実装します。

public partial class XmlEditor : Form {   DTE2 _applicationObject;   private DataSet _dataSet;   private string _xmlFilePath;   // コンストラクタ   public XmlEditor(DTE2 applicationObject)   {     // 呼び出し元のConnectクラスから     // アプリケーション・オブジェクトを引数で受け取り、     // それをフィールド変数にセットします     _applicationObject = applicationObject;     InitializeComponent();   }   // フォームのLoadイベント   private void XmlEditor_Load(object sender, EventArgs e)   {     // ［ソリューション エクスプローラ］で現在選択されている     // ファイルのコレクションを取得します     SelectedItems items = _applicationObject.SelectedItems;     // ファイルのコレクションの中から1つ目のアイテムを取得します     SelectedItem item = items.Item(1);     // ファイル・パスを取得してフィールド変数にセットします     _xmlFilePath = item.ProjectItem.get_FileNames(1);     _dataSet = new DataSet();     try     {       // データセットにファイルを読み込み、       // 内容をデータグリッドビューに表示します       _dataSet.ReadXml(_xmlFilePath);       xmlDataGridView.DataSource = _dataSet.Tables[0];       // 読み込んだファイル名をラベルに表示します       fileNameLabel.Text = item.Name;     }     catch (Exception)     {       // 読み込んだファイルがXML形式でない場合、       // エラー・メッセージをラベルに表示して、       // ［保存］ボタンを無効化します       fileNameLabel.Text = "ファイルの読み込みに失敗しました";       saveButton.Enabled = false;     }   }   // ［保存］ボタンのClickイベント   private void saveButton_Click(object sender, EventArgs e)   {     // データグリッドビューで編集された内容を     // XMLファイルに保存します     _dataSet.WriteXml(_xmlFilePath);   } }

コード1-2 XmlEditorクラス

○2. コマンド実行時の処理を実装する

　コマンド実行時にXMLファイル編集画面を表示する処理を、ConnectクラスのExecメソッドに実装します。

public void Exec(string commandName, vsCommandExecOption executeOption, ref object varIn, ref object varOut, ref bool handled) {   handled = false;   if (executeOption ==         vsCommandExecOption.vsCommandExecOptionDoDefault)   {     // ［SampleAddin］コマンドが実行された場合     if (commandName == "SampleAddin.Connect.SampleAddin")     {       // XMLファイル編集画面を生成して表示します       XmlEditor form = new XmlEditor(_applicationObject);       form.ShowDialog();       handled = true;       return;     }   } }

コード1-3 ConnectクラスのExecメソッド

　ここまででアドインの作成は終了です。それでは、デバッグ実行して動作を確認してみましょう。

○3. XMLファイル編集画面をデバッグ実行で確認する

　3- サンプルとして、次のような内容のXMLファイル（Employees.xmlファイル）をプロジェクトに追加作成します。

<?xml version="1.0" standalone="yes"?> <employees>   <employee>     <id>001</id>     <name>山田</name>     <age>34</age>   </employee>   <employee>     <id>002</id>     <name>佐藤</name>     <age>24</age>   </employee>   <employee>     <id>003</id>     <name>鈴木</name>     <age>30</age>   </employee> </employees>

新規作成するEmployees.xmlファイル

　3- ［ソリューション エクスプローラ］上で「Employees.xml」を右クリックし、コンテキスト・メニューから［SampleAddinで編集］をクリックします。これにより、次の画面のように［XmlEditor］ウィンドウ（XMLファイル編集画面）が表示されます。

図1-6 「XMLファイル編集画面」が表示される

　2- XMLファイル編集画面で、次の画面のようにデータを1件追加してみましょう。

図1-7 XMLファイルを編集する

　2- ［保存］ボタンをクリックしたら編集内容がXMLファイルに反映されていることを確認しましょう。以下の内容が追加されているはずです。

<employee>     <id>004</id>     <name>木村</name>     <age>33</age>   </employee>

「XMLファイル編集画面」での編集によりEmployees.xmlファイルに追加される行

　うまくいったでしょうか。以上で今回目的としていた処理の実装は完了です。最後に、ファイル項目以外のコンテキスト・メニューやツールバー、メニューバーにコマンドを表示する方法について紹介しておきます。

INDEX
	［特集］初めてのVisual Studioアドイン（前編）
	開発環境Visual Studioをカスタマイズせよ！
	1．Visual Studioの機能を拡張する3つの方法
	2．アドインを作成してみよう
	3．アドインを実行してみよう
	4．アドイン・プロジェクトの中身を見てみよう
	［特集］初めてのVisual Studioアドイン（中編）
	Visual Studioアドインを実装しIDEで使う！
	1．コンテキスト・メニューにコマンドを表示する
	2．コマンド実行時にXMLファイル編集画面を表示する
	3．コマンドをいろいろな場所に表示してみよう
	［特集］初めてのVisual Studioアドイン（後編）
	Visual Studioアドインを配布する！
	1．Visual Studioにアドインが登録される流れ／アドインの配布に必要な作業
	2．インストーラの作成手順

＠ITメールマガジン　新着情報やスタッフのコラムがメールで届きます（無料）