Elemento ProjectItem (modelos de item do Visual Studio)

Artigo
01/13/2024

Especifica um arquivo 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 elemento para item ProjectItem . Para obter uma explicação do ProjectItem elemento para modelos de projeto, consulte ProjectItem element (Visual Studio project templates).

Syntax

<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 atributos, elementos filho e elementos pai.

Atributos

Atributo	Descrição
`SubType`	Atributo opcional. Especifica o subtipo de um item em um modelo de item de vários arquivos. Esse valor é usado para determinar o editor que o 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.
`ReplaceParameters`	Atributo opcional . Um valor booleano que especifica se o item tem 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 a substituição de parâmetros para criar um nome de item.

Elementos filho

Nenhum.

Elementos pai

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

Valor do texto

Um valor de texto é obrigatório.

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

Comentários

ProjectItem é um filho opcional de TemplateContent.

O TargetFileName atributo pode ser usado para renomear arquivos com parâmetros. Por exemplo, se o arquivo MyFile.vb existir no diretório raiz do arquivo de .zip modelo, mas você quiser que o arquivo seja nomeado com base no nome de arquivo fornecido pelo usuário na caixa de diálogo Adicionar Novo Item, use 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 caixa de diálogo Adicionar Novo Item . Isso é útil ao criar modelos de item de vários arquivos. Para obter mais informações, consulte Como: Criar modelos de item de vários arquivos e parâmetros de modelo.

Exemplo

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

Partilhar via