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

このトピックの最初の手順では、テンプレートのエクスポート ウィザードを使って項目テンプレートを作成する方法を示します。The steps in the first procedure of this topic show 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.

ウィザードはさまざまな作業を実行して基本テンプレートを作成しますが、多くの場合、テンプレートをエクスポートした後で .vstemplate ファイルを手動で変更する必要があります。The wizard does a lot of work for you to create the basic template, but in many cases you will need to manually modify the .vstemplate file after you have exported the template. たとえば、Windows 8.x ストアWindows 8.x Store アプリ プロジェクトの [新しい項目の追加] ダイアログに項目を表示する場合、追加の手順をいくつか実行する必要があります。For example, if you want the item to appear in the Add New Item dialog for a Windows 8.x ストアWindows 8.x Store app project, you'll have to perform a few extra steps. このトピックの 2 つ目の手順では、このタスクの実行方法を説明します。The second procedure in this topic helps you accomplish that task.

Office、Database、Web など、特定のプロジェクト サブタイプにのみテンプレートが表示されるように指定するには、このセクションをご覧ください。To specify that your template should only appear for only certain project sub-types, such as Office, Database or Web, see this section.

場合によっては、項目テンプレートをゼロから手動で作成する必要があります。In some cases you may want or need to create an item template manually from scratch. 3 つ目の手順では、この方法について説明します。The third procedure shows how to do that.

.vstemplate ファイルで使用できる要素の詳細については、「Visual Studio テンプレート スキーマ参照」をご覧ください。See the Visual Studio Template Schema Reference for information about the elements that can be used in the .vstemplate file.

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

  1. Visual StudioVisual Studio でプロジェクトを作成または開きます。Create or open a project in Visual StudioVisual 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, click Export Template.

  5. [項目テンプレート] をクリックし、項目を含むプロジェクトを選んで、[次へ] をクリックします。Click Item Template, select the project that contains the item, and click Next.

  6. テンプレートを作成する項目を選び、[次へ] をクリックします。Select the item for which you want to create a template, and click Next.

  7. テンプレートに含めるアセンブリ参照を選び、[次へ] をクリックします。Select the assembly references to include in the template, and click Next.

  8. アイコン ファイル名、プレビュー イメージ、テンプレート名、およびテンプレートの説明を入力し、[完了] をクリックします。Type the icon file name, preview image, template name, and template description, and click Finish.

    テンプレートのファイルは .zip ファイルに追加され、ダイアログで指定した任意のディレクトリにコピーされます。The files for the template are added to a .zip file and copied whatever directory you specify in the dialog. 規定の場所は、..\Users\<ユーザー名>\Documents\Visual Studio <バージョン>\My Exported Templates\ フォルダーです。The default location is ..\Users\<username>\Documents\Visual Studio <Version>\My Exported Templates\ folder.

    警告

    旧バージョンの Visual Studio での規定の場所は、..\Users\<ユーザー名>\Documents\Visual Studio <バージョン>\Templates\ItemTemplates です。In earlier versions of Visual Studio, the default location is ..\Users\<username>\Documents\Visual Studio <Version>\Templates\ItemTemplates.

ストア プロジェクトで項目テンプレートを使用できるようにするにはTo enable the item template to be used in a store project

  1. 上記の手順に従って、項目テンプレートをエクスポートします。Follow the steps in the procedure above to export an item template.

  2. ..\Users\ユーザー名\Documents\Visual Studio バージョン\Templates\ItemTemplates\ (または My Exported Templates) フォルダーにコピーされた .zip ファイルから、.vstemplate ファイルを抽出します。Extract the .vstemplate file from the .zip file that was copied to the ..\Users\username\Documents\Visual Studio Version\Templates\ItemTemplates\ (or My Exported Templates) folder.

  3. Visual Studio で .vstemplate ファイルを開きます。Open the .vstemplate file in Visual Studio.

  4. ユニバーサル Windows C# プロジェクトの場合は、.vstemplate ファイルで開始 <TemplateData> タグの中に XML、<TemplateID>Microsoft.CSharp.Class</TemplateID> を追加します。For a Universal Windows C# project, in the .vstemplate file, add the following XML within the opening <TemplateData> tag : <TemplateID>Microsoft.CSharp.Class</TemplateID>.

    Windows 8.1 ストア用の C# プロジェクトの場合は、.vstemplate ファイルで <TemplateData> の開始タグと終了タグの中に XML、<TemplateGroupID>WinRT-Managed</TemplateGroupID> を追加します。For a Windows 8.1 store C# project, in the .vstemplate file, add the following XML within the opening and closing <TemplateData> tag: <TemplateGroupID>WinRT-Managed</TemplateGroupID>.

    Windows 8.1 ストア用の C++ プロジェクトでは、値として WinRT-Native-6.3 を使用します。A C++ Windows 8.1 store project uses a value of WinRT-Native-6.3. Windows 10 およびその他の種類のプロジェクトの場合については、「TemplateGroupID 要素 (Visual Studio テンプレート)」をご覧ください。For Windows 10 and other project types, see TemplateGroupID Element (Visual Studio Templates).

    次の例は、XML 行 <TemplateGroupID>WinRT-Managed</TemplateGroupID> が追加された後の .vstemplate ファイルの内容全体を示しています。The following example shows the entire contents of a .vstemplate file after the line of XML <TemplateGroupID>WinRT-Managed</TemplateGroupID> has been added to it. この例は、C# プロジェクトに固有です。This example is specific to C# projects. 要素と <TemplateGroupID> 要素を変更して、他の言語とプロジェクトの種類を指定することができます。You can modify the and < TemplateGroupID> elements to specify other language and project types.

    <VSTemplate Version="3.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">  
      <TemplateData>  
        <DefaultName>MyItemStoreTemplate.xaml</DefaultName>  
        <Name>MyItemStoreTemplate</Name>  
        <Description>This is an example itemtemplate</Description>  
        <ProjectType>CSharp</ProjectType>  
        <SortOrder>10</SortOrder>  
        <Icon>__TemplateIcon.ico</Icon>  
        <TemplateGroupID>WinRT-Managed</TemplateGroupID>  
      </TemplateData>  
      <TemplateContent>  
        <References />  
        <ProjectItem SubType="Designer" TargetFileName="$fileinputname$.xaml" ReplaceParameters="true">MyItemTemplate.xaml</ProjectItem>  
        <ProjectItem SubType="Code" TargetFileName="$fileinputname$.xaml.cs" ReplaceParameters="true">MyItemTemplate.xaml.cs</ProjectItem>  
      </TemplateContent>  
    </VSTemplate>  
    

    他に使用可能な TemplateGroupID の値については、「TemplateGroupID 要素 (Visual Studio テンプレート)」をご覧ください。For other possible TemplateGroupID values, see TemplateGroupID Element (Visual Studio Templates)). .vstemplate の総合的なリファレンスについては、「Visual Studio テンプレート スキーマ参照」をご覧ください。For the complete .vstemplate reference, see Visual Studio Template Schema Reference

  5. Visual Studio で、.vstemplate ファイルを保存して閉じます。In Visual Studio, save the .vstemplate file and close it.

  6. .vstemplate ファイルをコピーし、..\Users\ユーザー名\Documents\Visual Studio バージョン\Templates\ItemTemplates\ フォルダーにある .zip ファイルに貼り付けます。Copy and paste the .vstemplate file back to the .zip file located in the ..\Users\username\Documents\Visual Studio Version\Templates\ItemTemplates\ folder.

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

    これで、[新しい項目の追加] ダイアログ ボックスを使って、このテンプレートに基づく項目を Windows 8.x ストアWindows 8.x Store プロジェクトに追加できます。You can now add an item based on this template to a Windows 8.x ストアWindows 8.x Store project by using the Add New Item dialog box.

    パラメーター名の詳細については、「テンプレート パラメーター」をご覧ください。For more information about parameter names, see Template Parameters.

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

  1. 開発環境では、特定のプロジェクトに対して、[項目の追加] ダイアログ ボックスからプロジェクト項目を使用可能にすることができます。The development environment enables you to make project items available from the Add Item dialog box for certain projects. この手順を使用して、Windows プロジェクト、Web プロジェクト、Office プロジェクト、データベース プロジェクトでカスタム項目を使用可能にすることができます。Use this procedure to make custom items available for Windows, Web, Office, or database projects.

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

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

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

    1. WindowsWindows

    2. OfficeOffice

    3. データベースDatabase

    4. WebWeb

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

      Office プロジェクトで使用可能な項目テンプレートの例を次に示します。The following example shows an item template available 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

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

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

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

  4. XML ファイルを作成し、.vstemplate のファイル名拡張子を使用して、新しい項目テンプレートと同じディレクトリに保存します。Create an XML file and save it by using a .vstemplate file name extension, in the same directory as your new item template.

  5. 項目テンプレート メタデータを提供するための .vstemplate XML ファイルを作成します。Author the .vstemplate XML file to provide item template metadata. 詳しくは、「Visual Studio テンプレート スキーマ参照」と前のセクションの例をご覧ください。For more information, see Visual Studio Template Schema Reference and the example in the previous section.

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

  7. エクスプローラーで、テンプレートに含めるファイルを選択します。右クリックして [送信] をクリックし、[圧縮 (zip 形式) フォルダー] をクリックします。In Windows Explorer, select the files you want to include in your template, right-click the selection, click Send To, and then click 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 での規定のディレクトリは、..\Users\<ユーザー名>\Documents\Visual Studio 2017\Templates\ItemTemplates\ です。In Visual Studio 2017, the default directory is ..\Users\<username>\Documents\Visual Studio 2017\Templates\ItemTemplates\. 詳細については、「方法 : プロジェクト テンプレートと項目テンプレートを配置して整理する」を参照してください。For more information, see How to: Locate and Organize Project and Item Templates.

関連項目See Also

プロジェクトと項目テンプレートの作成 Creating Project and Item Templates
方法 : 複数ファイルの項目テンプレートを作成する How to: Create Multi-file Item Templates
Visual Studio テンプレート スキーマ参照Visual Studio Template Schema Reference