Elemento ProjectItem (modelos de projeto do Visual Studio)

Artigo
01/13/2024

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

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 modelos de projeto. Para obter uma explicação do elemento para modelos de ProjectItem item, consulte ProjectItem Element (Visual Studio Item Templates).

Syntax

<ProjectItem
    TargetFileName="TargetFileName.ext"
    ReplaceParameters="true/false"
    OpenInEditor="true/false"
    OpenInWebBrowser="true/false"
    OpenInHelpBrowser="true/false"
    OpenOrder="Value">
        FileName.ext
</ProjectItem>

Atributos e elementos

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

Atributos

Atributo	Descrição
`TargetFileName`	Atributo opcional. Especifica o nome e o caminho do item de projeto quando um projeto é criado a partir do modelo. Esse atributo é útil para criar uma estrutura de diretório diferente da estrutura de diretórios no arquivo de .zip de modelo ou para usar a substituição de parâmetros para criar um nome de item.
`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`.
`OpenInEditor`	Atributo opcional . Um valor booleano que especifica se o item deve ser aberto em seu respectivo editor no Visual Studio quando um projeto é criado a partir do modelo. Os `OpenInWebBrowser` atributos e `OpenInHelpBrowser` são ignorados em um item com um `OpenInEditor` valor de `true`. O valor padrão é `false`.
`OpenInWebBrowser`	Atributo opcional . Um valor booleano que especifica se o item deve ser aberto no navegador da Web quando um projeto é criado a partir do modelo. Somente arquivos HTML e arquivos de texto que são locais para o projeto podem ser abertos no navegador da Web. URLs externas não podem ser abertas com esse atributo. O valor padrão é `false`.
`OpenInHelpBrowser`	Atributo opcional . Um valor booleano que especifica se o item deve ser aberto no visualizador da Ajuda quando um projeto é criado a partir do modelo. Somente arquivos HTML e arquivos de texto que são locais para o projeto podem ser abertos no navegador de Ajuda. URLs externas não podem ser abertas com esse atributo. O valor padrão é `false`.
`OpenOrder`	Atributo opcional . Especifica um valor numérico que representa a ordem em que os itens serão abertos em seus respectivos editores. Todos os valores devem ser múltiplos de 10. Os itens com valores mais altos `OpenOrder` são abertos primeiro.

Elementos filho

Nenhum.

Elementos pai

Elemento	Descrição
Projeto	Especifica os arquivos ou diretórios a serem adicionados ao projeto.

Valor do texto

Um valor de texto é obrigatório.

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

Comentários

ProjectItem é um filho opcional de Project.

O TargetFileName atributo pode ser usado para criar uma estrutura de diretório diferente da estrutura de diretórios no arquivo de .zip modelo. Por exemplo, se o arquivo MyFile.vb existir na raiz do arquivo de .zip modelo, mas você quiser que o arquivo seja colocado em um diretório chamado CustomFiles em todos os projetos criados a partir do modelo, você usaria o seguinte XML:

<ProjectItem TargetFileName="CustomFiles\MyFile.vb">MyFile.vb</ProjectItem>

O TargetFileName atributo também pode ser usado para renomear arquivos que contêm caracteres internacionais em seus nomes de arquivo. Por exemplo, um arquivo de .zip de modelo não pode conter nomes de arquivo com caracteres Unicode, portanto, o arquivo deve ser renomeado antes de poder ser compactado em um arquivo .zip. O TargetFileName atributo pode ser usado para definir o nome do arquivo de volta para o nome do arquivo Unicode original.

O TargetFileName atributo também pode ser usado para renomear arquivos com parâmetros. O procedimento a seguir explica como renomear o arquivo MyFile.vb, que existe no diretório raiz do arquivo de .zip modelo, para um nome de arquivo baseado no nome do projeto.

Para renomear arquivos com parâmetros

Use o seguinte XML no arquivo .vstemplate :

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

Abra o arquivo de projeto (.vbproj para um projeto do Visual Basic) em um editor de texto ou Visual Studio.
Localize a linha no arquivo de projeto que se parece com o seguinte XML:
```
<Compile Include="MyFile.vb">
```
Substitua a linha de código com o seguinte XML:
```
<Compile Include="$safeprojectname$.vb">
```
Quando um projeto é criado a partir desse modelo, o nome do arquivo será baseado no nome que o usuário inseriu na caixa de diálogo Novo Projeto , com todos os caracteres e espaços não seguros removidos. Para obter mais informações, consulte Parâmetros de modelo.

Exemplo

O exemplo a seguir mostra os metadados para um modelo de projeto de um aplicativo do Visual C#.

<VSTemplate Type="Project" Version="3.0.0"
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
    <TemplateData>
        <Name>My template</Name>
        <Description>A basic starter kit</Description>
        <Icon>TemplateIcon.ico</Icon>
        <ProjectType>CSharp</ProjectType>
    </TemplateData>
    <TemplateContent>
        <Project File="MyStarterKit.csproj">
            <ProjectItem ReplaceParameters="true">Form1.cs<ProjectItem>
            <ProjectItem>Form1.Designer.cs</ProjectItem>
            <ProjectItem>Program.cs</ProjectItem>
            <ProjectItem>Properties\AssemblyInfo.cs</ProjectItem>
            <ProjectItem>Properties\Resources.resx</ProjectItem>
            <ProjectItem>Properties\Resources.Designer.cs</ProjectItem>
            <ProjectItem>Properties\Settings.settings</ProjectItem>
            <ProjectItem>Properties\Settings.Designer.cs</ProjectItem>
        </Project>
    </TemplateContent>
</VSTemplate>

Compartilhar via