Compartilhar via


Elemento ProjectItem (modelos de projeto Visual Studio)

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

ObservaçãoObservaçã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 sobre o ProjectItem elemento para modelos de item, consulte Elemento 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 seções a seguir descrevem os atributos, elementos filho e elementos pai.

Atributos

Attribute

Description

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órios diferente da estrutura de diretório no arquivo. zip de modelo, ou usando a substituição de parâmetro para criar um nome de item.

ReplaceParameters

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.

OpenInEditor

Atributo opcional.

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

O OpenInWebBrowser e OpenInHelpBrowser atributos sejam ignorados em um item com uma OpenInEditor o valor 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 os 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 os 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 abertos com esse atributo.

O valor padrão é false.

OpenOrder

Atributo opcional.

Especifica um valor numérico que representa a ordem em que itens serão abertos em seus respectivos editores. Todos os valores devem ser múltiplos de 10. Itens com menor OpenOrder valores são abertos pela primeira vez.

Elementos filho

Nenhum.

Elementos pai

Element

Description

Project

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

Valor de texto

É necessário um valor de texto.

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

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ório no arquivo de modelo. zip. Por exemplo, se o arquivo MyFile.vb existe na raiz do arquivo. zip de modelo, mas o arquivo de ser colocado em um diretório chamado CustomFiles em todos os projetos criados 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 os arquivos que contêm caracteres internacionais em seus nomes de arquivos. Por exemplo, um arquivo. zip de modelo não pode conter nomes de arquivo com caracteres Unicode, portanto, o arquivo deve ser renomeado antes que ele pode ser compactado em um arquivo. zip. O TargetFileName atributo pode ser usado para definir o nome de arquivo para o nome da arquivo original do Unicode.

O TargetFileName atributo também pode ser usado para renomear os 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 com base no nome do projeto.

Para renomear arquivos com parâmetros

  1. Use o seguinte XML no arquivo. vstemplate:

    <ProjectItem TargetFileName="$safeprojectname$.vb">MyFile.vb</ProjectItem>
    
  2. Abra o arquivo de projeto (. vbproj para um Visual Basic project) em um editor de texto ou Visual Studio. Para obter mais informações sobre a edição de arquivos de projeto no vsprvs, consulte How to: Edit Project Files.

  3. Localize a linha no arquivo de projeto semelhante ao seguinte XML:

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

    <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 Novo projeto caixa de diálogo, com todos os caracteres inseguros e espaços removidos. For more information, see Parâmetros de modelo.

Exemplo

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

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

Tarefas

Como: Criar manualmente modelos de projeto

Referência

Referência de esquema de modelo do Studio Visual

Elemento ProjectItem (modelos de Item Visual Studio)

Conceitos

Parâmetros de modelo

Como: Iniciar arquivos específicos quando abrir os modelos

Outros recursos

Modelos Visual Studio