項目テンプレートを作成する
この記事では、テンプレートのエクスポート ウィザードを使って項目テンプレートを作成する方法を示します。 テンプレートを複数のファイルで構成する場合は、「方法 : 複数ファイルの項目テンプレートを作成する」を参照してください。
項目テンプレートを [新しい項目の追加] ダイアログ ボックスに追加する
Visual Studio でプロジェクトを作成するか開きます。
項目をプロジェクトに追加し、必要に応じて変更します。
コード ファイルを変更して、パラメーター置換を行う場所を示します。 詳細については、「方法: テンプレート内のパラメーターを置き換える」を参照してください。
[プロジェクト] メニューの [テンプレートのエクスポート] を選択します。
[テンプレートの種類の選択] ページで、[項目テンプレート] を選び、項目を含むプロジェクトを選択して、[次へ] を選択します。
[エクスポートする項目の選択] ページで、テンプレートを作成する項目を選択し、[次へ] を選択します。
[項目参照の選択] ページで、テンプレートに含めるアセンブリ参照を選択し、[次へ] を選択します。
[テンプレート オプションの選択] ページで、テンプレートの名前および省略可能な説明、アイコン画像、プレビュー画像を入力して、[完了] を選択します。 項目のアイコン ファイルは、「Visual Studio のイメージとアイコン - ファイルの種類」の説明の通り
.icoファイルです。 プレビュー イメージは、[新しい項目の追加] ダイアログ ボックスに表示される 200 x 200 のイメージです。Visual Studio イメージ ライブラリで、Visual Studio スタイルと一致するアイコンを確認できます。
テンプレートのファイルが .zip ファイルに追加されて、ウィザードで指定したディレクトリにコピーされます。 既定の場所は、%USERPROFILE%\Documents\Visual Studio <バージョン>\My Exported Templates です。
テンプレートのエクスポート ウィザードで [テンプレートを自動的に Visual Studio にインポート] オプションを選ばなかった場合は、エクスポートされたテンプレートを見つけます。 次に、それをユーザー項目テンプレートのディレクトリにコピーします。 既定の場所は、%USERPROFILE%\Documents\Visual Studio <バージョン>\Templates\ItemTemplates です。
Visual Studio をいったん閉じて開きなおします。
新しいプロジェクトを作成するか、既存のプロジェクトを開き、[プロジェクト]>[新しい項目の追加] の順に選ぶか、Ctrl+Shift+A キーを押します。
項目テンプレートが、[新しい項目の追加] ダイアログ ボックスに表示されます。 テンプレートのエクスポート ウィザードで説明を追加した場合、ダイアログ ボックスの右側に説明が表示されます。
ユニバーサル Windows アプリ プロジェクトで項目テンプレートを有効にする
基本的なテンプレートを作成する作業の多くはウィザードで行われますが、多くの場合、テンプレートをエクスポートした後で .vstemplate ファイルを手動で変更する必要があります。 たとえば、ユニバーサル Windows アプリ プロジェクトの [新しい項目の追加] ダイアログに項目を表示する場合、追加の手順をいくつか実行する必要があります。
前のセクションの手順に従って、項目テンプレートをエクスポートします。
作成された .zip ファイルを抽出し、Visual Studio で .vstemplate ファイルを開きます。
C# ユニバーサル Windows プロジェクトの場合は、次の XML を
<TemplateData>要素内に追加します。<TemplateID>Microsoft.CSharp.Class</TemplateID>Visual Studio で、.vstemplate ファイルを保存して閉じます。
.vstemplate ファイルをコピーして、.zip ファイルに戻します。
[ファイルのコピー] ダイアログ ボックスが表示されたら、[コピーして置き換える] をクリックします。
これで、[新しい項目の追加] ダイアログ ボックスから、このテンプレートに基づく項目をユニバーサル Windows プロジェクトに追加できます。
特定のプロジェクト サブタイプのテンプレートを有効にする
Windows、Office、Database、Web など、特定のプロジェクト サブタイプにのみテンプレートが表示されるように指定できます。
項目テンプレートの .vstemplate ファイルで、
ProjectType要素を探します。ProjectSubType 要素を
ProjectType要素の直後に追加します。要素のテキスト値を次のいずれかの値に設定します。
- Windows
- Office
- データベース
- Web
たとえば、<ProjectSubType>Database</ProjectSubType> のように指定します。
Office プロジェクトの項目テンプレートの例を次に示します。
<VSTemplate Version="2.0.0" Type="Item" Version="2.0.0">
<TemplateData>
<Name>Class</Name>
<Description>An empty class file</Description>
<Icon>Class.ico</Icon>
<ProjectType>CSharp</ProjectType>
<ProjectSubType>Office</ProjectSubType>
<DefaultName>Class.cs</DefaultName>
</TemplateData>
<TemplateContent>
<ProjectItem>Class1.cs</ProjectItem>
</TemplateContent>
</VSTemplate>
項目テンプレートを手動で作成する
場合によっては、項目テンプレートをゼロから手動で作成する必要があります。
プロジェクトとプロジェクト項目を作成します。
プロジェクト項目を変更して、テンプレートとして保存できる状態にします。
必要に応じて、コード ファイルを変更し、パラメーター置換を行う場所を示します。 パラメーター置換の詳細については、「方法: テンプレート内のパラメーターを置き換える」を参照してください。
XML ファイルを作成し、.vstemplate ファイル拡張子を使って、プロジェクトの項目ファイルと同じディレクトリに保存します。
項目テンプレート メタデータを提供するための .vstemplate XML ファイルを編集します。 詳細については、「Visual Studio テンプレート スキーマ参照 (機能拡張)」と、前のセクションの例を参照してください。
.vstemplate ファイルを保存して閉じます。
Windows エクスプローラーで、テンプレートに含めるファイルを選択します。 選択したファイルを右クリックし、[送る]>[圧縮 (zip 形式) フォルダー] の順に選びます。 選択したファイルは .zip ファイルに圧縮されます。
.zip ファイルをコピーして、ユーザーの項目テンプレートの場所に貼り付けます。 既定のディレクトリは、%USERPROFILE%\Documents\Visual Studio 2022\Templates\ItemTemplates です。 詳細については、「方法: プロジェクト テンプレートと項目テンプレートを配置して整理する」を参照してください。