プロジェクトテンプレートでウィザードを使用する

[アーティクル]
10/10/2023

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

プロジェクトテンプレートのカスタマイズを使用すると、ユーザー入力を収集してテンプレートをカスタマイズしたり、テンプレートにファイルを追加したり、プロジェクトで許可されているその他のアクションを実行したりするカスタム UI を表示できます。

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

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

カスタムテンプレートの作成は、Visual Studio SDK の一部であるプロジェクトテンプレートプロジェクトから始めます。この手順では、C# プロジェクトテンプレートプロジェクトを使用しますが、Visual Basic プロジェクトテンプレートプロジェクトもあります。次に、プロジェクトテンプレートプロジェクトを含むソリューションに VSIX プロジェクトを追加します。

C# プロジェクトテンプレートプロジェクトを作成します (Visual Studio で、[ファイル]>[新規]>[プロジェクト] を選択し、「プロジェクトテンプレート」を検索します)。 MyProjectTemplate と名前を付けます。

Note

Visual Studio SDK のインストールを求められる場合があります。詳細については、「Visual Studio SDK のインストール」を参照してください。
プロジェクトテンプレートプロジェクトと同じソリューションに新しい VSIX プロジェクトを追加します (ソリューションエクスプローラーで、ソリューションノードを選択し、右クリックして、[追加]>[新しいプロジェクト] を選択し、「vsix」を検索します)。 MyProjectWizard と名前を付けます。
VSIX プロジェクトをスタートアッププロジェクトとして設定します。 ソリューションエクスプローラーで VSIX プロジェクトノードを選択し、右クリックして、[スタートアッププロジェクトに設定] を選択します。
テンプレートプロジェクトを VSIX プロジェクトのアセットとして追加します。 ソリューションエクスプローラーの VSIX プロジェクトノードで、source.extension.vsixmanifest ファイルを見つけます。それをダブルクリックしてマニフェストエディターで開きます。
マニフェストエディターで、ウィンドウの左側にある [アセット] タブを選択します。
[アセット] タブで、[新規] を選択します。 [新しい資産の追加] ウィンドウの [種類] フィールドで [Microsoft.VisualStudio.ProjectTemplate] を選択します。 [ソース] フィールドで、[現在のソリューション内のプロジェクト] を選択します。 [プロジェクト] フィールドで、[MyProjectTemplate] を選択します。 OK をクリックします。
ソリューションをビルドし、デバッグを開始します。 Visual Studio の 2 番目のインスタンスが表示されます。 (これには数分かかることがあります)。
Visual Studio の 2 番目のインスタンスで、新しいテンプレートを使用して新しいプロジェクトを作成してみてください ([ファイル]>[新規]>[プロジェクト] を選択し、「myproject」を検索します)。 Class1 という名前のクラスがある新しいプロジェクトが表示されます。これでカスタムプロジェクトテンプレートの作成は完了です。すぐにデバッグを停止してください。

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

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

アセンブリを作成できるように VSIX プロジェクトを設定します。
ソリューションエクスプローラーで VSIX プロジェクトノードを選択します。 ソリューションエクスプローラーの下にプロパティ ウィンドウが表示されます。そうでない場合は、[表示]>[プロパティウィンドウ] を選択するか、F4 キーを押します。 プロパティ ウィンドウでは、次のフィールドに true を選択します。
- [Include Assembly in VSIX Container] (VSIX コンテナーにアセンブリを含める)
- [Include Debug Symbols in Local VSIX Deployment] (ローカルの VSIX 配置にデバッグシンボルを含める)
- [Include Debug Symbols in VSIX Container] (VSIX コンテナーにデバッグシンボルを含める)
アセンブリをアセットとして VSIX プロジェクトに追加します。 source.extension.vsixmanifest ファイルを開き、[資産] タブを選択します。[新しい資産の追加] ウィンドウで、[種類] に [Microsoft.VisualStudio.Assembly] を選択し、[ソース] に [現在のソリューション内のプロジェクト] を選択し、[プロジェクト] に [MyProjectWizard] を選択します。
以下の参照を VSIX プロジェクトに追加します (ソリューションエクスプローラーの VSIX プロジェクトノードで、[参照] を選択し、右クリックして、[参照の追加] を選択します)。[参照の追加] ダイアログの [フレームワーク] タブで、System.Windows フォーム アセンブリを見つけて選択します。また、System と System.Drawing の各アセンブリを見つけて選択します。次に、[拡張機能] タブを選択します。EnvDTE アセンブリを見つけて選択します。また、Microsoft.VisualStudio.TemplateWizardInterface アセンブリを見つけて選択します。 OK をクリックします。
ウィザード実装のクラスを VSIX プロジェクトに追加します (ソリューションエクスプローラーで、VSIX プロジェクトノードを右クリックし、[追加]、[新しい項目]、[クラス] の順に選択します)。クラスに WizardImplementation と名前を付けます。

WizardImplementationClass.cs ファイルのコードを次のコードに置き換えます。

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

namespace MyProjectWizard
{
    public class WizardImplementation: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 = UserInputForm.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;
        }
    }
}

このコードで参照されている UserInputForm は、後で実装されます。

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

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

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

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

次に、UserInputForm を作成します。 WizardImplementation.cs ファイルで、WizardImplementation クラスの末尾の後に次のコードを追加します。

public partial class UserInputForm : Form
    {
        private static string customMessage;
        private TextBox textBox1;
        private Button button1;

        public UserInputForm()
        {
            this.Size = new System.Drawing.Size(155, 265);

            button1 = new Button();
            button1.Location = new System.Drawing.Point(90, 25);
            button1.Size = new System.Drawing.Size(50, 25);
            button1.Click += button1_Click;
            this.Controls.Add(button1);

            textBox1 = new TextBox();
            textBox1.Location = new System.Drawing.Point(10, 25);
            textBox1.Size = new System.Drawing.Size(70, 20);
            this.Controls.Add(textBox1);
        }
        public static string CustomMessage
        {
            get
            {
                return customMessage;
            }
            set
            {
                customMessage = value;
            }
        }
        private void button1_Click(object sender, EventArgs e)
        {
            customMessage = textBox1.Text;
            this.Close();
        }
    }

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

ウィザードをカスタムテンプレートに接続する

カスタムプロジェクトテンプレートでカスタムウィザードを使用するには、ウィザードアセンブリに署名し、カスタムプロジェクトテンプレートにいくつかの行を追加して、新しいプロジェクトが作成されたときにウィザードの実装がどこにあるかを把握できるようにする必要があります。

アセンブリにサインします。 ソリューションエクスプローラーで、VSIX プロジェクトを選択し、右クリックして、[プロジェクトのプロパティ] を選択します。
[プロジェクトのプロパティ] ウィンドウで、[署名] タブを選択します。[署名] タブで、[アセンブリの署名] を確認します。 厳密な名前のキーファイルを選択するフィールドで、<新規>を選択します。 [厳密な名前キーの作成] ウィンドウの [キーファイル名] フィールドに「key.snk」と入力します。 [キーファイルをパスワードで保護する] フィールドをオフにします。
ソリューションエクスプローラーで、VSIX プロジェクトを選択し、[プロパティ] ウィンドウを見つけます。
[Copy Build Output to Output Directory]$ビルド出力を出力ディレクトリにコピーする$ フィールドを [true] に設定します。これにより、ソリューションのリビルド時にアセンブリが出力ディレクトリにコピーされるようになります。これはまだ .vsix ファイルに含まれています。署名キーを調べるには、アセンブリを確認する必要があります。
ソリューションをリビルドします。
これで、MyProjectWizard プロジェクトディレクトリで key.snk ファイル (<ご使用のディスクの場所>\MyProjectTemplate\MyProjectWizard\key.snk) を見つけることができます。 key.snk ファイルをコピーします。
出力ディレクトリに移動し、アセンブリ (<ご使用のディスクの場所>\MyProjectTemplate/MyProjectWizard\bin\Debug\MyProjectWizard.dll) を見つけます。 key.snk ファイルをここに貼り付けます (これは絶対に必要というわけではありませんが、次の手順が簡単になります)。
コマンドウィンドウを開き、アセンブリが作成されたディレクトリに移動します。
sn.exe 署名ツールを見つけます。たとえば、Windows 10 64 ビットオペレーティングシステムでは、一般的なパスは次のようになります。

C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.6.1 Tools

ツールが見つからない場合は、コマンドウィンドウで where /R . sn.exe を実行してみてください。パスをメモします。
key.snk ファイルから公開キーを抽出します。コマンドウィンドウで、次のように入力します

<sn.exe の場所>\sn.exe -p key.snk outfile.key.

ディレクトリ名にスペースがある場合は、sn.exe のパスを必ず引用符で囲んでください。
出力ファイルから公開キートークンを取得します。

<sn.exe の場所>\sn.exe -t outfile.key.

繰り返しになりますが、引用符を忘れないでください。次のような行が出力に表示されます。

Public key token is <token> (公開キートークンは <トークン> です)

この値を書き留めておきます。
カスタムウィザードへの参照をプロジェクトテンプレートの .vstemplate ファイルに追加します。 ソリューションエクスプローラーで、MyProjectTemplate.vstemplate という名前のファイルを見つけて開きます。 <TemplateContent> セクションの末尾の後に、次のセクションを追加します。
```
<WizardExtension>
    <Assembly>MyProjectWizard, Version=1.0.0.0, Culture=Neutral, PublicKeyToken=token</Assembly>
    <FullClassName>MyProjectWizard.WizardImplementation</FullClassName>
</WizardExtension>
```
この MyProjectWizard はアセンブリの名前であり、token は前の手順でコピーしたトークンです。
プロジェクト内のすべてのファイルを保存してリビルドします。

テンプレートにカスタムパラメーターを追加する

この例で、テンプレートとして使用されるプロジェクトには、カスタムウィザードのユーザー入力フォームに指定されたメッセージが表示されます。

ソリューションエクスプローラーで、MyProjectTemplate プロジェクトに移動し、Class1.cs を開きます。
アプリケーションの Main メソッドに次のコード行を追加します。
```
Console.WriteLine("$custommessage$");
```
$custommessage$ パラメーターは、プロジェクトをテンプレートから作成する際にユーザー入力フォームに入力したテキストで置き換えられます。

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

using System;
using System.Collections.Generic;
$if$ ($targetframeworkversion$ >= 3.5)using System.Linq;
$endif$using System.Text;

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

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

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

ソリューションをリビルドし、デバッグを開始します。 Visual Studio の 2 番目のインスタンスが表示されます。
新しい MyProjectTemplate プロジェクトを作成します ([ファイル]>[新規]>[プロジェクト])。
[新しいプロジェクト] ダイアログボックスで「myproject」を検索してテンプレートを見つけ、名前を入力し、[OK] をクリックします。

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

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

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

次の方法で共有

プロジェクトテンプレートでウィザードを使用する

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

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

ウィザードをカスタムテンプレートに接続する

テンプレートにカスタムパラメーターを追加する

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

その他のリソース

次の方法で共有

プロジェクト テンプレートでウィザードを使用する

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

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

ウィザードをカスタム テンプレートに接続する

テンプレートにカスタム パラメーターを追加する

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

関連するコンテンツ

その他のリソース

プロジェクトテンプレートでウィザードを使用する

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

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

ウィザードをカスタムテンプレートに接続する

テンプレートにカスタムパラメーターを追加する

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