ProjectItem 要素 (Visual Studio 項目テンプレート)
項目テンプレートに含まれているファイルを指定します。
[!メモ]
ProjectItem 要素は、テンプレートがプロジェクト用かアイテム用かによって受け入れる属性が異なります。ここでは、アイテムの ProjectItem 要素について説明します。プロジェクト テンプレートの ProjectItem 要素については、「ProjectItem 要素 (Visual Studio プロジェクト テンプレート)」を参照してください。
<ProjectItem
SubType="Form/Component/CustomControl/UserControl"
CustomTool="string"
ItemType="string"
ReplaceParameters="true/false"
TargetFileName="TargetFileName.ext">
FileName.ext
</ProjectItem>
属性および要素
以降のセクションでは、属性、子要素、および親要素について説明します。
属性
属性 |
説明 |
|---|---|
SubType |
省略可能な属性です。 複数ファイルの項目テンプレートにあるアイテムのサブタイプを指定します。この値を使って、Visual Studio がアイテムを開くときに使用するエディターを指定します。 |
CustomTool |
省略可能な属性です。 プロジェクト ファイルの項目の CustomTool を設定します。 |
ItemType |
省略可能な属性です。 プロジェクト ファイルの項目の ItemType を設定します。 |
ReplaceParameters |
省略可能な属性です。 ブール値を使用します。これは、プロジェクトがテンプレートから作成されるときに、置換する必要のあるパラメーター値がアイテムに存在するかどうかを指定します。既定値は falseです。 |
TargetFileName |
省略可能な属性です。 テンプレートから作成されるアイテムの名前を指定します。この属性は、アイテム名を作成するためにパラメーター置換をする場合に便利です。 |
子要素
なし。
親要素
要素 |
説明 |
|---|---|
テンプレートの内容を指定します。 |
テキスト値
テキスト値が必要です。
string は、テンプレート .zip ファイルにあるファイルの名前を示します。
解説
ProjectItem は TemplateContent の省略可能な子要素です。
TargetFileName 属性は、パラメーターでファイルの名前を変更する場合にも使用できます。たとえば、MyFile.vb というファイルがテンプレート .zip ファイルのルートにあるとします。このファイルを [新しい項目の追加] ダイアログ ボックスで入力したファイル名に基づいた名前に変更するには、次の XML を使用します。
<ProjectItem TargetFileName="$fileinputname$.vb">MyFile.vb</ProjectItem>
このテンプレートからアイテムが作成されると、ファイルには [新しい項目の追加] ダイアログ ボックスで入力した名前に基づいた名前が付けられます。これは、複数ファイルの項目テンプレートを作成する場合に便利です。詳細については、「方法 : 複数ファイルの項目テンプレートを作成する」および「テンプレート名」を参照してください。
使用例
Visual C# クラスでの標準的な項目テンプレートのメタデータの例を次に示します。
<VSTemplate Type="Item" Version="3.0.0"
xmlns="https://schemas.microsoft.com/developer/vstemplate/2005">
<TemplateData>
<Name>MyClass</Name>
<Description>My custom C# class.</Description>
<Icon>Icon.ico</Icon>
<ProjectType>CSharp</ProjectType>
<DefaultName>MyClass.cs</DefaultName>
</TemplateData>
<TemplateContent>
<ProjectItem ReplaceParameters="true">MyClass.cs</ProjectItem>
</TemplateContent>
</VSTemplate>