Compartilhar via


Elementos ProjectItem (modelos de projeto Visual Studio)

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

ObservaçãoObservação

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

<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 seguintes seções descrevem o atributo, elementos filhos, e os elementos pai.

Atributos

Atributo

Descrição

TargetFileName

atributo opcional.

Especifica o nome e 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ório no arquivo .zip de modelo, ou para usar substituição de parâmetro para criar um nome de item.

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.

OpenInEditor

atributo opcional.

Um valor Booleano que especifica se o item deve ser aberto no editor respectivo em Visual Studio quando um projeto é criado a partir do modelo.

Atributos de OpenInWebBrowser e de OpenInHelpBrowser são ignorados em um item com um valor de OpenInEditor de true.

o valor padrão é false.

OpenInWebBrowser

atributo opcional.

Um valor Booleano que especifica se o item deve ser aberto o 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 abertos 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 ajuda.Urls externas não podem ser abertos com esse atributo.

o valor padrão é false.

OpenOrder

atributo opcional.

Especifica um valor numérico que representa a ordem que os itens serão abertos em seus respectivos editores.todos os valores devem ser múltiplos de 10.Os itens com valores superiores de OpenOrder são abertos primeiro.

Elementos filho

Nenhum.

Elementos pai

Elemento

Descrição

Projeto

Especifica os arquivos ou diretórios para adicionar ao projeto.

Valor de texto

Um valor de texto é necessário.

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

Comentários

ProjectItem é um filho de Projectopcional.

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

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

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

O atributo de TargetFileName 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 modelo .zip, um nome de arquivo baseado no nome do projeto.

para renomear arquivos com parâmetros

  1. Use o seguinte XML para o arquivo .vstemplate:

    <ProjectItem TargetFileName="$safeprojectname$.vb">MyFile.vb</ProjectItem>
    
  2. Abra o arquivo de projeto (.vbproj para um projeto de Visual Basic ) em um editor de texto ou em Visual Studio.

  3. Localize a linha no arquivo de projeto que os aspectos semelhantes ao XML a seguir:

    <Compile Include="MyFile.vb">
    
  4. Substitua a linha de código com XML a seguir:

    <Compile Include="$safeprojectname$.vb">
    

    Quando um projeto é criado em este modelo, o nome de arquivo será baseado no nome que o usuário inseriu na caixa de diálogo de Novo Projeto , com todos os caracteres inseguros e espaços removidos.Para obter mais informações, consulte Parâmetros de modelo.

Exemplo

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

<VSTemplate Type="Project" Version="3.0.0"
    xmlns="https://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>

Consulte também

Referência

Referência do esquema de modelo do Visual Studio

Elementos ProjectItem modelos de item (Visual Studio)

Conceitos

Introdução aos modelos de Visual Studio

Parâmetros de modelo