Elemento ProjectItem (modelos de Item Visual Studio)

Especifica um arquivo que está incluído no modelo de item.

Observação
O ProjectItem elemento aceita atributos diferentes, dependendo se o modelo para um projeto ou um item. Este tópico explica o ProjectItem elemento para o item. Para obter uma explicação sobre o ProjectItem elemento para modelos de projeto, consulte Elemento ProjectItem (modelos de projeto Visual Studio).

<ProjectItem
    SubType="Form/Component/CustomControl/UserControl"
    CustomTool="string"
    ItemType="string"
    ReplaceParameters="true/false"
    TargetFileName="TargetFileName.ext">
        FileName.ext
</ProjectItem>

Atributos e elementos

As seções a seguir descrevem os atributos, elementos filho e elementos pai.

Atributos

Attribute	Description
SubType	Atributo opcional. Especifica o subtipo de um item em um modelo de item multiarquivos. Esse valor é usado para determinar o editor que Visual Studio usará para abrir o item.
CustomTool	Atributo opcional. Define o CustomTool para o item no arquivo de projeto.
ItemType	Atributo opcional. Define o ItemType para o item no arquivo de projeto.
ReplaceParamenters	Atributo opcional. Um valor booleano que especifica se o item possui os valores de parâmetro devem ser substituídos quando um projeto é criado a partir do modelo. Valor padrão é false.
TargetFileName	Atributo opcional. Especifica o nome do item que é criado a partir do modelo. Esse atributo é útil para usar a substituição de parâmetro para criar um nome de item.

Elementos filho

Nenhum.

Elementos pai

Element	Description
TemplateContent	Especifica o conteúdo do modelo.

Valor de texto

É necessário um valor de texto.

A string que representa o nome de um arquivo no arquivo de modelo. zip.

Comentários

ProjectItemé um filho opcional de TemplateContent.

O TargetFileName atributo pode ser usado para renomear os arquivos com parâmetros. Por exemplo, se o arquivo MyFile.vb existe no diretório raiz do arquivo. zip de modelo, mas você deseja que o arquivo será nomeado com base no nome do arquivo fornecido pelo usuário na Add New Item caixa de diálogo, você usaria o seguinte XML:

<ProjectItem TargetFileName="$fileinputname$.vb">MyFile.vb</ProjectItem>

Quando um item é criado a partir desse modelo, o nome do arquivo será baseado no nome que o usuário inseriu na Add New Item caixa de diálogo. Isso é útil ao criar modelos de item multiarquivos. For more information, see Como: Criar modelos de Item multiarquivos and Parâmetros de modelo.

Exemplo

O exemplo a seguir ilustra os metadados para o modelo de item padrão para um Visual C# classe.

<VSTemplate Type="Item" Version="2.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>

Consulte também

Tarefas

Como: Criar modelos de Item multiarquivos

Referência

Referência de esquema de modelo do Studio Visual

Conceitos

Parâmetros de modelo

Outros recursos

Modelos Visual Studio