ProjectItem 元素（Visual Studio 项模板）

  • 项目

指定项模板中包含的文件。

注意

该 ProjectItem 元素接受不同的属性，具体取决于模板是用于项目还是项。 本主题介绍 ProjectItem 项的元素。 有关项目模板元素的说明ProjectItem，请参阅 ProjectItem 元素（Visual Studio 项目模板）。

<VSTemplate><TemplateContent><ProjectItem>

语法

<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 可选特性。

指定从模板创建的项的名称。 此属性可用于使用参数替换来创建项名称。

子元素

无。

父元素

元素 说明
TemplateContent 指定模板的内容。

文本值

需要一个文本值。

一个 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="http://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>

另请参阅