Elemento ProjectItem (modelos de item do Visual Studio)

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

Dica

O elemento de ProjectItem aceita atributos diferentes dependendo se o modelo é para um projeto ou item.este tópico explica o elemento de ProjectItem para o item.Para obter uma explicação do elemento de ProjectItem para modelos de projeto, consulte Elemento ProjectItem (modelos de projeto do 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 seguintes seções descrevem o atributo, elementos filhos, e os elementos pai.

Atributos

Atributo	Descrição
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 a CustomTool para o item no arquivo Projeto.
ItemType	atributo opcional. Define o ItemType para o item no arquivo Projeto.
ReplaceParameters	atributo opcional. Um valor Booleano que especifica se o item já os valores de parâmetro que devem ser substituídos quando um projeto é criado a partir do modelo. o valor padrão é false.
TargetFileName	atributo opcional. Especifica o nome do item que é criado a partir do modelo. Esse atributo é útil para usar substituição de parâmetro para criar um nome de item.

Elementos filho

Nenhum.

Elementos pai

Elemento	Descrição
TemplateContent	Especifica o conteúdo do modelo.

Valor de texto

Um valor de texto é necessário.

string representando o nome de um arquivo em um arquivo .zip de modelo.

Comentários

ProjectItem é um filho de TemplateContentopcional.

o atributo de TargetFileName pode ser usado para renomear arquivos com parâmetros. Por exemplo, se o arquivo MyFile.vb existir no diretório raiz do arquivo de modelo .zip, mas você desejar que o arquivo a ser chamado com base no nome de arquivo fornecido pelo usuário na caixa de diálogo de Adicionar novo item , você usaria XML a seguir:

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

Quando um item é criado em este modelo, o nome de arquivo será baseado no nome que o usuário inseriu na caixa de Adicionar novo item . Isso é útil ao criar modelos de item multiarquivos. Para obter mais informações, consulte Como criar modelos de item multiarquivo e Parâmetros de modelo.

Exemplo

O exemplo a seguir ilustra os metadados para o modelo de item padrão para uma classe de 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>

Consulte também

Tarefas

Como criar modelos de item multiarquivo

Referência

Referência de esquema do modelo do Visual Studio

Conceitos

Criando modelos para projetos e itens no Visual Studio

Parâmetros de modelo