チュートリアル: プロジェクトの読み込み時にトリガーされる簡単なプロジェクト機能の作成

2011-08-15

更新 : 2010 年 7 月

プロジェクト関連のアクションが発生したときにカスタム動作を実行するプロジェクト機能を作成できます。このチュートリアルでは、データベースプロジェクトが読み込まれたときにダイアログボックスを表示する、SampleProjectFeature という名前のプロジェクト機能を作成します。このサンプルを変更して、データベースプロジェクトが読み込まれたときにアクションを実行することもできます。

このチュートリアルでは、次の主要タスクを行います。

Visual Studio パッケージの作成
プロジェクト機能の定義
プロジェクト機能のテスト

必須コンポーネント

このチュートリアルを実行するには、次のコンポーネントが必要です。

Visual Studio 2010 Professional、Visual Studio 2010 Premium、または Visual Studio 2010 Ultimate をインストールしておく必要があります。
データベースプロジェクトが必要です。
また、コンピューターに Visual Studio 2010 SDK をインストールしておく必要があります。このキットをダウンロードするには、Microsoft Web サイトの Visual Studio 2010 SDK のページを参照してください。

注意

このチュートリアルは、既に Visual Studio のデータベース機能を使い慣れているユーザーを対象としています。また、クラスライブラリの作成方法、コードエディターを使用してクラスにコードを追加する方法など、Visual Studio の基本的な概念を理解している必要があります。

Visual Studio パッケージの作成

Visual Studio Integration Package ウィザードを開始するには

[ファイル] メニューの [新規作成] をポイントし、[プロジェクト] をクリックします。
[インストールされたテンプレート] の一覧で、[その他のプロジェクトの種類] ノードを展開し、[機能拡張] ノードをクリックします。
詳細ペインで [Visual Studio Integration Package] をクリックします。

重要

Visual Studio 2010 SDK をインストールしていない場合、プロジェクトの種類として [Visual Studio Integration Package] は表示されません。
[名前] ボックスに「SampleProjectFeature」と入力します。
[OK] をクリックします。

Visual Studio Integration Package ウィザードが表示されます。

次に、ウィザードを使用して、作成するプロジェクトを構成します。

Visual Studio Integration Package ウィザードを使用してプロジェクトを作成するには

[次へ] をクリックします。
[言語の選択] で、[Visual C#] をクリックします。

注意

Visual Basic または Visual C++ を使用してパッケージを作成することもできます。このチュートリアルでは、Visual Basic および Visual C# のサンプルコードのみを示します。
[アセンブリ署名用のキーの取得] で、[アセンブリ署名用の新しいキーファイルを生成する] をクリックします。
[次へ] をクリックします。
[会社名] ボックスに「MyCompany」と入力します。
[VSPackage 名] ボックスに「SampleProjectFeature」と入力します。
(省略可能) 特定のバージョン番号を指定できます。
(省略可能) パッケージで使用するアイコンをカスタマイズできます。
(省略可能) [詳細情報] ボックスに、パッケージについての詳細情報を入力できます。
[次へ] をクリックします。
[メニューコマンド] チェックボックスをオンにします。
[ツールウィンドウ] チェックボックスと [カスタムエディター] チェックボックスがオフになっていることを確認します。
[次へ] をクリックします。
[コマンド名] ボックスに「Toggle Project Loaded Dialogs」と入力します。
[コマンド ID] ボックスに「cmdidEnableDialogs」と入力します。
[次へ] をクリックします。
[統合テストプロジェクト] チェックボックスおよび [単体テストプロジェクト] チェックボックスをオフにします。

注意

組織で実際に使用するパッケージを作成する場合は、パッケージが正しく機能することを確認するために、パッケージのテストを作成することを検討してください。
[完了] をクリックします。

"Visual Studio Integration Package" という名前のプロジェクトが作成され、ソリューションエクスプローラーに表示されます。

次に、パッケージのコードをカスタマイズして、データベースプロジェクト機能を定義します。

プロジェクト機能の定義

データベースプロジェクト機能を定義するためにパッケージ定義を変更するには、パッケージ定義を更新し、SampleProjectFeature クラスを追加する必要があります。

パッケージ定義を更新するには

ソリューションエクスプローラーで SampleProjectFeaturePackage.cs ファイルをダブルクリックして、このファイルをコードエディターで開きます。
コードエディターで、MenuItemCallback メソッドを探します。
このメソッドの定義を次のコードに置き換えます。
```
        private void MenuItemCallback(object sender, EventArgs e)
        {
            SampleProjectFeature.EnableDialogs = !SampleProjectFeature.EnableDialogs;
        }
```
注意

SampleProjectFeature クラスと EnableDialogs メソッドをまだ定義していないため、[エラー一覧] にエラーが表示されます。
[ファイル] メニューの [SampleProjectFeaturePackage.cs の保存] をクリックします。

次に、プロジェクト機能のクラスを定義します。

SampleProjectFeature クラスを定義するには

ソリューションエクスプローラーで、SampleProjectFeature プロジェクトを右クリックし、[追加] をポイントし、[クラス] をクリックします。

クラステンプレートが既に強調表示された状態で、[新しい項目の追加] ダイアログボックスが表示されます。
[名前] ボックスに「SampleProjectFeature.cs」と入力します。
[追加] をクリックします。

新しいクラスがプロジェクトに追加され、クラス定義を示すコードエディターが表示されます。
ソリューションエクスプローラーで、プロジェクトを右クリックし、[参照の追加] をクリックします。

[参照の追加] ダイアログボックスが表示されます。
[.NET] タブをクリックします。
コンポーネントの一覧で、次の参照を強調表示し、[OK] をクリックします。
- Microsoft.Data.Schema
- Microsoft.VisualStudio.Data.Schema.Package

コードエディターで、次の using ステートメントをクラス定義に追加します。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.Data.Schema.Extensibility;
using Microsoft.Data.Schema;
using Microsoft.VisualStudio.Data.Schema.Package.Project;
using Microsoft.VisualStudio.Shell.Interop;
using System.Globalization;

クラス定義を変更して、基本クラスを指定し、この機能と互換性のあるデータベーススキーマプロバイダーを表す属性を指定します。このチュートリアルで示す例は、すべてのデータベーススキーマプロバイダーと互換性があります。
```
    [DatabaseSchemaProviderCompatibility(typeof(DatabaseSchemaProvider))]
    class SampleProjectFeature : IDatabaseProjectFeature
    {
    }
```
重要なインターフェイス、型、およびメソッドは、DatabaseSchemaProviderCompatibilityAttribute、DatabaseSchemaProvider、および IDatabaseProjectFeature です。
次の 2 つのプロパティをクラスに追加します。
```
        public static bool EnableDialogs { get; set; }
        private IDatabaseProjectNode ProjectNode { get; set; }
```
1 つ目のプロパティは、このプロジェクト機能の有効と無効を切り替えるコマンドで使用します。重要なインターフェイスは IDatabaseProjectNode です。
次のコンストラクターをクラスに追加します。
```
        static SampleProjectFeature()
        {
            EnableDialogs = true;
        }
```
このコンストラクターは、EnableDialogs プロパティを初期化します。

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

        public void Initialize(IDatabaseProjectNode projectNode)
        {
            ProjectNode = projectNode;

            // Hook up to a few events
            ProjectNode.ProjectLoaded += delegate
            {
                ShowDialog("In ProjectLoaded Event");
            };
        }

Initialize メソッドは、機能を適用する対象のプロジェクトを特定し、ProjectLoaded イベントをウォッチする準備をします。

最後に、機能が有効な場合に ProjectLoaded イベントが発生したときにダイアログボックスを表示する ShowDialog メソッドを追加します。

        void ShowDialog(string msg)
        {
            if (!SampleProjectFeature.EnableDialogs)
                return;

            // Show a Message Box to indicate that we were here
            IVsUIShell uiShell = (IVsUIShell)Microsoft.VisualStudio.Shell.Package.GetGlobalService(typeof(SVsUIShell));
            Guid clsid = Guid.Empty;
            int result;
            Microsoft.VisualStudio.ErrorHandler.ThrowOnFailure(uiShell.ShowMessageBox(
                       0,
                       ref clsid,
                       "Simple Project Feature",
                       msg,
                       string.Empty,
                       0,
                       OLEMSGBUTTON.OLEMSGBUTTON_OK,
                       OLEMSGDEFBUTTON.OLEMSGDEFBUTTON_FIRST,
                       OLEMSGICON.OLEMSGICON_INFO,
                       0,        // false
                       out result));
        }

ユーザーがメニューコマンドを使用して機能をオフにした場合は、メソッドから制御が戻ります。それ以外の場合は、ダイアログボックスが表示されます。独自のプロジェクト機能では、ダイアログボックスを表示する代わりに、追加の処理を実行することもできます。

[ファイル] メニューの [SampleProjectFeature.cs の保存] をクリックします。

次に、プロジェクトをビルドします。

プロジェクトをビルドするには

[ビルド] メニューの [ソリューションのビルド] をクリックします。

次に、プロジェクトで生成されたアセンブリ情報を収集します。この情報には、バージョン、カルチャ、および PublicKeyToken が含まれます。

アセンブリ情報を収集するには

[スタート] ボタンをクリックし、[Microsoft Visual Studio 2010] をポイントします。次に、[Visual Studio Tools] をポイントし、[Visual Studio コマンドプロンプト (2010)] をクリックします。
ビルドしたアセンブリ (SampleProjectFeature.dll) が含まれているフォルダーに移動します。
次のコマンドラインを入力します。

SN.EXE -T SampleProjectFeature.dll
公開キートークンをメモします。これは次の手順で使用します。

次に、前の手順で収集したアセンブリ情報を使用して XML ファイルを作成します。

XML ファイルを作成するには

ソリューションエクスプローラーで、SampleProjectFeature プロジェクトを選択します。
[プロジェクト] メニューの [新しい項目の追加] をクリックします。
[テンプレート] ペインで、[XML ファイル] という項目を見つけて選択します。
[名前] ボックスに「SampleProjectFeature.Extensions.xml」と入力し、[追加] をクリックします。

ソリューションエクスプローラーで、プロジェクトに SampleProjectFeature.Extensions.xml ファイルが追加されます。

SampleProjectFeature.Extensions.xml ファイルを開き、次の XML に一致するように更新します。 PublicKeyToken は、前の手順で取得した値に置き換えます。

<?xml version="1.0" encoding="utf-8"?>
<extensions assembly=""
            version="1" xmlns="urn:Microsoft.Data.Schema.Extensions"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="urn:Microsoft.Data.Schema.Extensions Microsoft.Data.Schema.Extensions.xsd">

  <extension type=" MyCompany.SampleProjectFeature.SampleProjectFeature" assembly="SampleProjectFeature, Version=1.0.0.0, Culture=neutral, PublicKeyToken=nnnnnnnnnnnnnnnn" enabled="true"/>
</extensions>

[ファイル] メニューの [保存] をクリックします。

次に、Extensions.xml ファイルのプロパティを変更して、このファイルを vsixmanifest に含めます。

SampleProductFeature.Extensions.xml を vsixmanifest に含めるには

ソリューションエクスプローラーで、SampleProjectFeature.Extensions.xml をクリックします。
[プロパティ] ウィンドウで、[ビルドアクション] プロパティを [コンテンツ] に変更します。
[VSIX に含める] プロパティを [True] に変更します。
[ファイル] メニューの [すべてを保存] をクリックします。
[ビルド] メニューの [SampleProjectFeature のビルド] をクリックします。

vsixmanifest ファイルが更新されます。これで、プロジェクト機能をテストする準備が整いました。

プロジェクト機能のテスト

プロジェクト機能をテストするには、最初にプロジェクトをビルドする必要があります。その後、F5 キーを押して Visual Studio の実験用ビルドを開始できます。

データベースプロジェクト機能をビルドしてテストするには

[プロジェクト] メニューの [ビルド] をクリックします。

プロジェクトがビルドされます。
F5 キーを押して、Visual Studio の実験用ビルドでパッケージを実行します。

Visual Studio の実験用のインスタンスが表示されます。 [ツール] メニューに、Toggle Project Loaded Dialogs コマンドが表示されます。
[ファイル] メニューの [開く] をポイントし、[プロジェクト/ソリューション] をクリックします。
開くデータベースプロジェクト (.dbproj) を参照し、[開く] をクリックします。

データベースプロジェクトが読み込まれると、"Simple Project Feature In ProjectLoaded Event" というメッセージを示すダイアログボックスが表示されます。

この時点で、プロジェクト機能をカスタマイズして機能を追加できます。

次の手順

このチュートリアルで作成した機能をコピーして作業の開始点として使用する場合は、以下を実行する必要があります。

拡張機能に一意の名前を付けます。
拡張機能に一意の GUID を付けます。

Visual Studio Integration Package ウィザードを使用して新しいパッケージを作成すると、自動的に新しい GUID が作成されます。

Visual Studio の標準のインスタンスでパッケージを使用可能にするには、パッケージを登録する必要があります。 VSPackage の詳細については、以下を参照してください。

参照

履歴の変更

日付	履歴	理由
2010 年 7 月	Extensions.xml ファイルをわずかに修正して、お客様が確認した問題を解決しました。	カスタマーフィードバック

2010 年 7 月

Extensions.xml ファイルをわずかに修正して、お客様が確認した問題を解決しました。

カスタマーフィードバック