Elemento ProjectItem (plantillas de proyecto de Visual Studio)

Artículo
10/10/2023

Especifica un archivo que se incluye en la plantilla de proyecto.

Nota:

El ProjectItem elemento acepta atributos diferentes en función de si la plantilla es para un proyecto o un elemento. En este tema se explica el ProjectItem elemento para las plantillas de proyecto. Para obtener una explicación del elemento para las ProjectItem plantillas de elemento, vea Elemento ProjectItem (Plantillas de elementos de Visual Studio).

Sintaxis

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

Atributos y elementos

En las siguientes secciones se describen los atributos, los elementos secundarios y los elementos primarios.

Atributos

Atributo	Descripción
`TargetFileName`	Atributo opcional. Especifica el nombre y la ruta de acceso del elemento de proyecto cuando se crea un proyecto a partir de la plantilla. Este atributo es útil para crear una estructura de directorios diferente de la estructura de directorios en el archivo .zip de plantilla o para usar el reemplazo de parámetros para crear un nombre de elemento.
`ReplaceParameters`	Atributo opcional. Valor booleano que especifica si el elemento tiene valores de parámetro que se deben reemplazar cuando se crea un proyecto a partir de la plantilla. El valor predeterminado es `false`.
`OpenInEditor`	Atributo opcional. Valor booleano que especifica si el elemento debe abrirse en su editor correspondiente en Visual Studio cuando se crea un proyecto a partir de la plantilla. Los `OpenInWebBrowser` atributos y `OpenInHelpBrowser` se omiten en un elemento con un `OpenInEditor` valor de `true`. El valor predeterminado es `false`.
`OpenInWebBrowser`	Atributo opcional. Valor booleano que especifica si el elemento se debe abrir el explorador web cuando se crea un proyecto a partir de la plantilla. Solo se pueden abrir archivos HTML y archivos de texto locales para el proyecto en el explorador web. No se pueden abrir direcciones URL externas con este atributo. El valor predeterminado es `false`.
`OpenInHelpBrowser`	Atributo opcional. Valor booleano que especifica si el elemento debe abrirse en el visor de Ayuda cuando se crea un proyecto a partir de la plantilla. Solo se pueden abrir archivos HTML y archivos de texto locales para el proyecto en el explorador de Ayuda. No se pueden abrir direcciones URL externas con este atributo. El valor predeterminado es `false`.
`OpenOrder`	Atributo opcional. Especifica un valor numérico que representa el orden en que se abrirán los elementos en sus respectivos editores. Todos los valores deben ser múltiplos de 10. Los elementos con valores superiores `OpenOrder` se abren primero.

Elementos secundarios

Ninguno.

Elementos primarios

Elemento	Descripción
Proyecto	Especifica los archivos o directorios que se van a agregar al proyecto.

Valor de texto

Se requiere un valor de texto.

string que representa el nombre o la ruta de acceso a un archivo en el archivo .zip de plantilla.

Comentarios

ProjectItem es un elemento secundario opcional de Project.

El TargetFileName atributo se puede usar para crear una estructura de directorios diferente de la estructura de directorios del archivo .zip de plantilla. Por ejemplo, si el archivo MyFile.vb existe en la raíz del archivo .zip de plantilla, pero quiere que el archivo se coloque en un directorio denominado CustomFiles en todos los proyectos creados a partir de la plantilla, usará el siguiente XML:

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

El TargetFileName atributo también se puede usar para cambiar el nombre de los archivos que contienen caracteres internacionales en sus nombres de archivo. Por ejemplo, un archivo .zip de plantilla no puede contener nombres de archivo con caracteres Unicode, por lo que se debe cambiar el nombre del archivo antes de que se pueda comprimir en un archivo .zip. El TargetFileName atributo se puede usar para volver a establecer el nombre de archivo en el nombre de archivo Unicode original.

El TargetFileName atributo también se puede usar para cambiar el nombre de los archivos con parámetros. En el procedimiento siguiente se explica cómo cambiar el nombre del archivo MyFile.vb, que existe en el directorio raíz del archivo .zip de plantilla, a un nombre de archivo basado en el nombre del proyecto.

Para cambiar el nombre de los archivos con parámetros

Use el siguiente CÓDIGO XML en el archivo .vstemplate :

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

Abra el archivo de proyecto (.vbproj para un proyecto de Visual Basic) en un editor de texto o Visual Studio.
Busque la línea en el archivo del proyecto que tiene un aspecto similar al siguiente XML:
```
<Compile Include="MyFile.vb">
```
Reemplace la línea de código por el siguiente XML:
```
<Compile Include="$safeprojectname$.vb">
```
Cuando se crea un proyecto a partir de esta plantilla, el nombre de archivo se basará en el nombre que escribió el usuario en el cuadro de diálogo Nuevo proyecto , con todos los caracteres y espacios no seguros eliminados. Para obtener más información, consulte Parámetros de plantilla.

Ejemplo

El ejemplo siguiente muestra los metadatos de una plantilla de proyecto para una aplicación 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>