方法: 項目テンプレートを作成するHow to: Create item templates

この記事では、テンプレートのエクスポート ウィザードを使って項目テンプレートを作成する方法を示します。This article shows you how to create an item template by using the Export Template Wizard. テンプレートを複数のファイルで構成する場合は、「方法 : 複数ファイルの項目テンプレートを作成する」を参照してください。If your template will consist of multiple files, see How to: Create multi-file item templates.

ユーザー項目テンプレートを [新しい項目の追加] ダイアログ ボックスに追加するにはTo add a user item template to the Add New Item dialog box

  1. Visual Studio でプロジェクトを作成するか開きます。Create or open a project in Visual Studio.

  2. 項目をプロジェクトに追加し、必要に応じて変更します。Add an item to the project, and modify it if you want to.

  3. コード ファイルを変更して、パラメーター置換を行う場所を示します。Modify the code file to indicate where parameter replacement should take place. 詳細については、「方法: テンプレート内のパラメーターを置き換える」を参照してください。For more information, see How to: Substitute parameters in a template.

  4. [プロジェクト] メニューの [テンプレートのエクスポート] を選択します。On the Project menu, choose Export Template.

  5. [テンプレートの種類の選択] ページで、[項目テンプレート] を選び、項目を含むプロジェクトを選択して、[次へ] を選択します。On the Choose Template Type page, choose Item Template, select the project that contains the item, and then choose Next.

  6. [エクスポートする項目の選択] ページで、テンプレートを作成する項目を選択し、[次へ] を選択します。On the Select Item To Export page, choose the item you want to create a template for, and then choose Next.

  7. [項目参照の選択] ページで、テンプレートに含めるアセンブリ参照を選択し、[次へ] を選択します。On the Select Item References page, select the assembly references to include in the template, and then choose Next.

  8. [テンプレート オプションの選択] ページで、テンプレートの名前および省略可能な説明、アイコン画像、プレビュー画像を入力して、[完了] を選択します。On the Select Template Options page, enter the template name and optional description, icon image and preview image, and then choose Finish.

    テンプレートのファイルが .zip ファイルに追加されて、ウィザードで指定したディレクトリにコピーされます。The files for the template are added to a .zip file and copied to the directory you specified in the wizard. 既定の場所は、%USERPROFILE%\Documents\Visual Studio <バージョン>\My Exported Templates です。The default location is %USERPROFILE%\Documents\Visual Studio <version>\My Exported Templates.

  9. テンプレートのエクスポート ウィザード[テンプレートを自動的に Visual Studio にインポート] オプションを選ばなかった場合は、エクスポートされたテンプレートを見つけます。If you did not select the option Automatically import the template into Visual Studio in the Export Template Wizard, locate the exported template. 次に、それをユーザー項目テンプレートのディレクトリにコピーします。Then, copy it to the user item template directory. 既定の場所は、%USERPROFILE%\Documents\Visual Studio <バージョン>\Templates\ItemTemplates です。The default location is %USERPROFILE%\Documents\Visual Studio <version>\Templates\ItemTemplates.

  10. Visual Studio をいったん閉じて開きなおします。Close Visual Studio and then reopen it.

  11. 新しいプロジェクトを作成するか、既存のプロジェクトを開き、[プロジェクト] > [新しい項目の追加] の順に選ぶか、Ctrl+Shift+A キーを押します。Create a new project, or open an existing project, and then choose Project > Add New Item or press Ctrl+Shift+A.

    項目テンプレートが、[新しい項目の追加] ダイアログ ボックスに表示されます。The item template appears in the Add New Item dialog box. テンプレートのエクスポート ウィザードで説明を追加した場合、ダイアログ ボックスの右側に説明が表示されます。If you added a description in the Export Template Wizard, the description appears on the right side of the dialog box.

ユニバーサル Windows アプリ プロジェクトで項目テンプレートを使えるようにするにはTo enable the item template to be used in a Universal Windows App project

基本的なテンプレートを作成する作業の多くはウィザードで行われますが、多くの場合、テンプレートをエクスポートした後で .vstemplate ファイルを手動で変更する必要があります。The wizard does much of the work to create a basic template, but in many cases you need to manually modify the .vstemplate file after you have exported the template. たとえば、ユニバーサル Windows アプリ プロジェクトの [新しい項目の追加] ダイアログに項目を表示する場合、追加の手順をいくつか実行する必要があります。For example, if you want the item to appear in the Add New Item dialog for a Universal Windows App project, you have to perform a few extra steps.

  1. 前のセクションの手順に従って、項目テンプレートをエクスポートします。Follow the steps in the previous section to export an item template.

  2. 作成された .zip ファイルを抽出し、Visual Studio で .vstemplate ファイルを開きます。Extract the .zip file that was created, and open the .vstemplate file in Visual Studio.

  3. C# ユニバーサル Windows プロジェクトの場合は、次の XML を <TemplateData> 要素内に追加します。For a C# Universal Windows project, add the following XML inside the <TemplateData> element:

    <TemplateID>Microsoft.CSharp.Class</TemplateID>
    
  4. Visual Studio で、.vstemplate ファイルを保存して閉じます。In Visual Studio, save the .vstemplate file and close it.

  5. .vstemplate ファイルをコピーして、.zip ファイルに戻します。Copy and paste the .vstemplate file back to the .zip file.

    [ファイルのコピー] ダイアログ ボックスが表示されたら、[コピーして置き換える] をクリックします。If the Copy File dialog box appears, choose the Copy and Replace option.

これで、[新しい項目の追加] ダイアログ ボックスから、このテンプレートに基づく項目をユニバーサル Windows プロジェクトに追加できます。You can now add an item based on this template to a Universal Windows project from the Add New Item dialog box.

特定のプロジェクト サブタイプのテンプレートを有効にするにはTo enable templates for specific project subtypes

Windows、Office、Database、Web など、特定のプロジェクト サブタイプにのみテンプレートが表示されるように指定できます。You can specify that your template should only appear for only certain project subtypes, such as Windows, Office, Database, or Web.

  1. 項目テンプレートの .vstemplate ファイルで、ProjectType 要素を探します。Locate the ProjectType element in the .vstemplate file for the item template.

  2. ProjectSubType 要素を ProjectType 要素の直後に追加します。Add a ProjectSubType element immediately after the ProjectType element.

  3. 要素のテキスト値を次のいずれかの値に設定します。Set the text value of the element to one of the following values:

    • WindowsWindows
    • OfficeOffice
    • データベースDatabase
    • WebWeb

たとえば、<ProjectSubType>Database</ProjectSubType> のように指定します。For example: <ProjectSubType>Database</ProjectSubType>.

Office プロジェクトの項目テンプレートの例を次に示します。The following example shows an item template for Office projects.

<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>

テンプレートのエクスポート ウィザードを使用せずに項目テンプレートを手動で作成するにはTo manually create an item template without using the Export Template wizard

場合によっては、項目テンプレートをゼロから手動で作成する必要があります。In some cases you may want to create an item template manually, from scratch.

  1. プロジェクトとプロジェクト項目を作成します。Create a project and project item.

  2. プロジェクト項目を変更して、テンプレートとして保存できる状態にします。Modify the project item until it is ready to be saved as a template.

  3. 必要に応じて、コード ファイルを変更し、パラメーター置換を行う場所を示します。Modify the code file to indicate where parameter replacement should occur, if anywhere. パラメーター置換の詳細については、「方法: テンプレート内のパラメーターを置き換える」を参照してください。For more information about parameter replacement, see How to: Substitute parameters in a template.

  4. XML ファイルを作成し、.vstemplate ファイル拡張子を使って、プロジェクトの項目ファイルと同じディレクトリに保存します。Create an XML file and save it with a .vstemplate file extension in the same directory as your project item file.

  5. 項目テンプレート メタデータを提供するための .vstemplate XML ファイルを編集します。Edit the .vstemplate XML file to provide item template metadata. 詳細については、「Visual Studio テンプレート スキーマ参照 (機能拡張)」と、前のセクションの例を参照してください。For more information, see Template schema reference (extensibility) and the example in the previous section.

  6. .vstemplate ファイルを保存して閉じます。Save the .vstemplate file and close it.

  7. Windows エクスプローラーで、テンプレートに含めるファイルを選択します。In Windows Explorer, select the files you want to include in your template. 選択したファイルを右クリックし、[送る] > [圧縮 (zip 形式) フォルダー] の順に選びます。Right-click the selection, and choose Send to > Compressed (zipped) folder. 選択したファイルは .zip ファイルに圧縮されます。The files that you selected are compressed into a .zip file.

  8. .zip ファイルをコピーして、ユーザーの項目テンプレートの場所に貼り付けます。Copy the .zip file and paste it in the user item template location. Visual Studio 2017 での既定のディレクトリは、%USERPROFILE%\Documents\Visual Studio 2017\Templates\ItemTemplates です。In Visual Studio 2017, the default directory is %USERPROFILE%\Documents\Visual Studio 2017\Templates\ItemTemplates. 詳細については、「方法: プロジェクト テンプレートと項目テンプレートを配置して整理する」を参照してください。For more information, see How to: Locate and organize project and item templates.

関連項目See also