方法 : プロジェクトテンプレートを組み合わせたウィザードを使用する

[アーティクル]
08/09/2011

Visual Studio には、IWizard インターフェイスが用意されています。このインターフェイスを実装すると、ユーザーがテンプレートからプロジェクトを作成する際にカスタムコードを実行できるようになります。

プロジェクトテンプレートのカスタマイズを使用すると、次の操作を実行できます。

ユーザー入力を収集してテンプレートをパラメーター化するカスタム UI を表示できます。
テンプレートで使用するパラメーター値を追加できます。
テンプレートに他のファイルを追加できます。
Visual Studio オートメーションオブジェクトモデルによって許可されたアクションを実際にプロジェクトで実行できます。

IWizard インターフェイスメソッドは、プロジェクトの作成中にさまざまな時点で呼び出されます。プロジェクトの作成は、ユーザーが [新しいプロジェクト] ダイアログボックスの [OK] をクリックすると同時に開始されます。インターフェイスの各メソッドには、そのメソッドが呼び出される時点を表す名前が付けられます。たとえば、Visual Studio は、プロジェクトの作成の開始直後に RunStarted を呼び出します。この時点が、ユーザー入力を収集するためのカスタムコードの記述に適した場所になります。

カスタムウィザード用に記述するコードのほとんどでは、DTE オブジェクトを使用します。このオブジェクトは、プロジェクトをカスタマイズするための、Visual Studio オートメーションオブジェクトモデルの主要なオブジェクトです。オートメーションオブジェクトモデルの詳細については、「Visual Studio 環境の拡張」および「オートメーションと機能拡張のリファレンス」を参照してください。

カスタムテンプレートウィザードの作成

このトピックでは、プロジェクトを作成する前に Windows フォームを開くカスタムウィザードを作成する方法を紹介します。このフォームを使用すると、ユーザーは、プロジェクトの作成時にソースコードに後から追加されるカスタムパラメーター値を追加できます。主な手順を次に示し、各手順の詳細について説明します。

カスタムテンプレートウィザードを作成するには

IWizard インターフェイスを実装するアセンブリを作成します。
アセンブリをグローバルアセンブリキャッシュにインストールします。
プロジェクトを作成し、テンプレートのエクスポート ウィザードを使用して、そのプロジェクトからテンプレートを作成します。
テンプレートを変更します。ここでは、.vstemplate ファイルに WizardExtension 要素を追加し、IWizard を実装するアセンブリにテンプレートをリンクします。
カスタムウィザードを使用し、新しいプロジェクトを作成します。

IWizard の実装

このプロセスでは、最初に、IWizard を実装するアセンブリを作成します。このアセンブリは、RunStarted メソッドを使用し、ユーザーがカスタムパラメーター値を追加できる Windows フォームを表示します。このパラメーター値は、プロジェクトの作成時に使用されます。

注意

この例では、IWizard の実装に Visual C# を使用していますが、Visual Basic を使用することもできます。

IWizard を実装するには

新しいクラスライブラリプロジェクトを作成します。
IWizard インターフェイスを実装するクラスを作成します。完全に実装された IWizard インターフェイスの Visual C# の例については、後述のコードを参照してください。

この例には、2 つのコードファイルが含まれています。1 つは、IWizardImplementation という、IWizard インターフェイスを実装するクラスで、もう 1 つは、UserInputForm という、ユーザー入力用の Windows フォームです。

IWizardImplementation クラス

IWizardImplementation クラスには、IWizard のすべてのメンバーに対するメソッドの実装が含まれています。この例では、RunStarted メソッドだけがタスクを実行します。他のすべてのメソッドは、何もしないか、true を返します。

RunStarted メソッドは、次の 4 つのパラメーターを受け取ります。

Object パラメーター。プロジェクトをカスタマイズできるように、ルートの _DTE オブジェクトにキャストできます。
Dictionary<TKey, TValue> パラメーター。テンプレートで定義済みのすべてのパラメーターのコレクションが含まれます。テンプレートパラメーターの詳細については、「テンプレート名」を参照してください。
WizardRunKind パラメーター。使用されているテンプレートの種類に関する情報が含まれます。
Object 配列。Visual Studio によってウィザードに渡される一連のパラメーターが格納されます。

この例では、ユーザー入力フォームから Dictionary<TKey, TValue> パラメーターにパラメーター値を追加します。プロジェクト内の $custommessage$ パラメーターのすべてのインスタンスは、ユーザーが入力したテキストと置き換えられます。

using System;
using System.Collections.Generic;
using Microsoft.VisualStudio.TemplateWizard;
using System.Windows.Forms;
using EnvDTE;

namespace CustomWizard
{
    public class IWizardImplementation:IWizard
    {
        private UserInputForm inputForm;
        private string customMessage;

        // This method is called before opening any item that 
        // has the OpenInEditor attribute.
        public void BeforeOpeningFile(ProjectItem projectItem)
        {
        }

        public void ProjectFinishedGenerating(Project project)
        {
        }
        
        // This method is only called for item templates,
        // not for project templates.
        public void ProjectItemFinishedGenerating(ProjectItem 
            projectItem)
        {
        }

        // This method is called after the project is created.
        public void RunFinished()
        {
        }

        public void RunStarted(object automationObject,
            Dictionary<string, string> replacementsDictionary,
            WizardRunKind runKind, object[] customParams)
        {
            try
            {
                // Display a form to the user. The form collects 
                // input for the custom message.
                inputForm = new UserInputForm();
                inputForm.ShowDialog();

                customMessage = inputForm.get_CustomMessage();

                // Add custom parameters.
                replacementsDictionary.Add("$custommessage$", 
                    customMessage);
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.ToString());
            }
        }

        // This method is only called for item templates,
        // not for project templates.
        public bool ShouldAddProjectItem(string filePath)
        {
            return true;
        }        
    }
}

ユーザー入力フォーム

ユーザー入力フォームには、カスタムパラメーターを入力するための簡単なフォームが用意されています。このフォームには、textBox1 という名前のテキストボックスおよび button1 という名前のボタンがあります。このボタンをクリックすると、テキストボックスのテキストが customMessage パラメーターに格納されます。

Windows フォームをソリューションに追加するには

[プロジェクト] メニューの [新しい項目の追加] をクリックします。
[Windows フォーム] をクリックし、ファイルに「UserInputForm.cs」という名前を付けて、[OK] をクリックします。

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;

namespace CustomWizard
{
    public partial class UserInputForm : Form
    {
        private string customMessage;

        public UserInputForm()
        {
            InitializeComponent();
        }
       
        public string get_CustomMessage()
        {
            return customMessage;
        }

        private void button1_Click(object sender, EventArgs e)
        {
            customMessage = textBox1.Text;

            this.Dispose();
        }
    }
}

グローバルアセンブリキャッシュへのアセンブリのインストール

IWizard を実装するアセンブリは、厳密な名前で署名して、グローバルアセンブリキャッシュにインストールする必要があります。

アセンブリをグローバルアセンブリキャッシュにインストールするには

アセンブリに厳密な名前で署名します。詳細については、「方法 : 厳密な名前でアセンブリに署名する」または「方法 : アセンブリに署名する (Visual Studio)」を参照してください。
厳密な名前付きアセンブリをグローバルアセンブリキャッシュにインストールします。詳細については、「方法 : グローバルアセンブリキャッシュにアセンブリをインストールする」を参照してください。

テンプレートとして使用するプロジェクトの作成

この例でテンプレートとして使用されるプロジェクトは、カスタムウィザードのユーザー入力フォームで指定されたメッセージを表示するコンソールアプリケーションです。

サンプルプロジェクトを作成するには

Visual C# コンソールアプリケーションを新しく作成します。
アプリケーションの Main メソッドに次のコード行を追加します。
```
Console.WriteLine("$custommessage$");
```
$custommessage$ パラメーターは、プロジェクトをテンプレートから作成する際にユーザー入力フォームに入力したテキストで置き換えられます。
[ファイル] メニューの [テンプレートのエクスポート] をクリックします。
テンプレートのエクスポート ウィザードで、[プロジェクトテンプレート] をクリックし、適切なプロジェクトを選択して、[次へ] をクリックします。
テンプレートのエクスポート ウィザードで、テンプレートの説明情報を入力します。[テンプレートを自動的に Visual Studio にインポート] チェックボックスをオンにし、[完了] をクリックします。

これで、テンプレートは [新しいプロジェクト] ダイアログボックスに表示されるようになりますが、カスタムウィザードは使用しません。

テンプレートにエクスポートされる前のコードファイル全体の例を次に示します。

using System;
using System.Collections.Generic;
using System.Text;

namespace TemplateProject
{
    class WriteMessage
    {
        static void Main(string[] args)
        {
            Console.WriteLine("$custommessage$");
        }
    }
}

テンプレートの変更

テンプレートが作成され、[新しいプロジェクト] ダイアログボックスに表示されたら、前の手順で作成したアセンブリを使用するように、そのテンプレートを変更する必要があります。

カスタムウィザードをテンプレートに追加するには

テンプレートを含む .zip ファイルを探します。
1. [ツール] メニューの [オプション] をクリックします。
2. [プロジェクトおよびソリューション] をクリックします。
3. [Visual Studio ユーザープロジェクトテンプレートの場所] ボックスを確認します。詳細については、「[全般] ([オプション] ダイアログボックス - [プロジェクトおよびソリューション])」を参照してください。
既定の場所は、My Documents\Visual Studio 2010\Templates\ProjectTemplates です。
.zip ファイルを展開します。
Visual Studio で .vstemplate ファイルを開きます。
TemplateContent 要素の後に、カスタムウィザードアセンブリの厳密な名前の付いた WizardExtension 要素 (Visual Studio テンプレート) 要素を追加します。アセンブリの厳密な名前を検索する方法の詳細については、「方法 : グローバルアセンブリキャッシュの内容を表示する」および「方法 : 厳密な名前のアセンブリを参照する」を参照してください。

WizardExtension 要素の例を次に示します。
```
<WizardExtension>
    <Assembly>CustomWizard, Version=1.0.0.0, Culture=Neutral, PublicKeyToken=fa3902f409bb6a3b</Assembly>
    <FullClassName>CustomWizard.IWizardImplementation</FullClassName>
</WizardExtension>
```

カスタムウィザードの使用

これで、テンプレートからプロジェクトを作成し、カスタムウィザードを使用できるようになりました。

カスタムウィザードを使用するには

[ファイル] メニューの [新しいプロジェクト] をクリックします。
[新しいプロジェクト] ダイアログボックスで、テンプレートを指定し、名前を入力して、[OK] をクリックします。

ウィザードのユーザー入力フォームが開きます。
カスタムパラメーターの値を入力し、ボタンをクリックします。

ウィザードのユーザー入力フォームが終了し、プロジェクトがテンプレートから作成されます。
ソリューションエクスプローラーで、ソースコードファイルを右クリックし、[コードの表示] をクリックします。

$custommessage$ は、ウィザードのユーザー入力フォームに入力されたテキストで置き換えられています。

参照

WizardExtension 要素 (Visual Studio テンプレート)

IWizard

その他の技術情報

詳細なテンプレート手順

方法 : プロジェクト テンプレートを組み合わせたウィザードを使用する

カスタム テンプレート ウィザードの作成

カスタム テンプレート ウィザードを作成するには