TemplateData 要素 (Visual Studio テンプレート)
テンプレートをカテゴリに分類し、 [新しいプロジェクト] ダイアログ ボックス、または [新しい項目の追加] ダイアログ ボックスでどのように表示させるかを定義します。
<VSTemplate><TemplateData>
構文
<TemplateData>
<Name> ... </Name>
<Description> ... </Description>
<Icon> ... </Icon>
<ProjectType> ... </ProjectType>
...
</TemplateData>
属性および要素
以降のセクションでは、属性、子要素、および親要素について説明します。
属性
なし。
子要素
要素 | 説明 |
---|---|
名前 | 必須の要素です。 [新しいプロジェクト] または [新しい項目の追加] ダイアログ ボックスに表示されるテンプレートの名前を指定します。 |
説明 | 必須の要素です。 [新しいプロジェクト] または [新しい項目の追加] ダイアログ ボックスに表示されるテンプレートの説明を指定します。 |
アイコン | 必須の要素です。 アイコンとして機能する画像ファイルのパスとファイル名を指定します。これは、[新しいプロジェクト] または [新しい項目の追加] ダイアログ ボックスで、テンプレートに対して表示されます。 |
ProjectType | 必須の要素です。 プロジェクト テンプレートをカテゴリに分類し、[新しいプロジェクト] ダイアログ ボックスの指定されたグループに表示されるようにします。 |
ProjectSubType | 省略可能な要素です。 プロジェクト テンプレートを分類し、[新しいプロジェクト] ダイアログ ボックスの指定されたサブカテゴリに表示されるようにします。 |
TemplateID | 省略可能な要素です。 テンプレートの ID を指定します。 |
TemplateGroupID | 省略可能な要素です。 テンプレート グループの ID を指定します。 |
SortOrder | 省略可能な要素です。 [新しいプロジェクト] ダイアログ ボックスまたは [新しい項目の追加] ダイアログ ボックスに表示されるテンプレートを、同じカテゴリの他のテンプレートの中に配置するために使用される値を指定します。 |
CreateNewFolder | 省略可能な要素です。 プロジェクトをインスタンス化するときに、格納フォルダーを作成するかどうかを指定します。 |
DefaultName | 省略可能な要素です。 プロジェクトまたは項目の作成時にこれらに対して Visual Studio プロジェクト システムで生成される名前を指定します。 |
ProvideDefaultName | 省略可能な要素です。 プロジェクトまたは項目の作成時にこれらに対して Visual Studio プロジェクト システムで既定の名前を生成するかどうかを指定します。 |
PromptForSaveOnCreation | 省略可能な要素です。 プロジェクトを一時プロジェクトとして作成できるかどうかを指定します (Visual Studio 2017 のみ)。 |
EnableLocationBrowseButton | 省略可能な要素です。 [新しいプロジェクト] ダイアログ ボックスで [参照] ボタンを使用できるかどうかを指定します。これにより、新しいプロジェクトを保存する既定のディレクトリをユーザーが簡単に変更できるようになります。 |
非表示 | 省略可能な要素です。 [新しいプロジェクト] と [新しい項目の追加] のどちらのダイアログ ボックスにテンプレートを表示するかを指定します。 |
NumberOfParentCategoriesToRollUp | 省略可能な要素です。 [新しいプロジェクト] ダイアログ ボックスにテンプレートを表示する親カテゴリの数を指定します。 |
LocationFieldMRUPrefix | 省略可能な要素です。 |
LocationField | 省略可能な要素です。 [新しいプロジェクト] ダイアログ ボックスの [場所] テキスト ボックスが、プロジェクト テンプレートに対して有効、無効、または非表示のいずれであるかを指定します。 |
RequiredFrameworkVersion | 省略可能な要素です。 この要素は、テンプレートで .NET Framework の特定の最小バージョン (および、存在する場合はそれ以降のバージョン) のみがサポートされる場合に使用します。 |
SupportsMasterPage | 省略可能な要素です。 テンプレートで Web プロジェクトのマスター ページがサポートされるかどうかを指定します。 |
SupportsCodeSeparation | 省略可能な要素です。 テンプレートで Web プロジェクトのコード分離 (分離コード ページ モデル) がサポートされるかどうかを指定します。 |
SupportsLanguageDropDown | 省略可能な要素です。 テンプレートが複数の言語で同一であるかどうか、および [新しいプロジェクト] ダイアログ ボックスから[言語] オプションを使用できるかどうかを指定します。 |
TargetPlatformName | 省略可能な要素です。 プロジェクト テンプレートの対象となるプラットフォームを指定します。 この要素では、Windows 8.x ストア アプリを作成するためにプロジェクト テンプレートを使用することを指定します。 |
親要素
要素 | 説明 |
---|---|
VSTemplate | 必須の要素です。 プロジェクト テンプレート、項目テンプレート、またはスタート キットのすべてのメタデータが含まれます。 |
解説
TemplateData
は必須の要素です。
オプションの要素を含めない場合は、その要素の既定値が使用されます。
例
Visual C# アプリケーションでのプロジェクト テンプレートのメタデータの例を次に示します。
<VSTemplate Type="Project" Version="3.0.0"
xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
<TemplateData>
<Name>My template</Name>
<Description>A basic starter kit</Description>
<Icon>TemplateIcon.ico</Icon>
<ProjectType>CSharp</ProjectType>
</TemplateData>
<TemplateContent>
<Project File="MyStarterKit.csproj">
<ProjectItem>Form1.cs<ProjectItem>
<ProjectItem>Form1.Designer.cs</ProjectItem>
<ProjectItem>Program.cs</ProjectItem>
<ProjectItem>Properties\AssemblyInfo.cs</ProjectItem>
<ProjectItem>Properties\Resources.resx</ProjectItem>
<ProjectItem>Properties\Resources.Designer.cs</ProjectItem>
<ProjectItem>Properties\Settings.settings</ProjectItem>
<ProjectItem>Properties\Settings.Designer.cs</ProjectItem>
</Project>
</TemplateContent>
</VSTemplate>