ProjectItem (Elemento, Plantillas de elementos de Visual Studio)

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

[!NOTA]

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

<ProjectItem
    SubType="Form/Component/CustomControl/UserControl"
    CustomTool="string"
    ItemType="string"
    ReplaceParameters="true/false"
    TargetFileName="TargetFileName.ext">
        FileName.ext
</ProjectItem>

Atributos y elementos

Las siguientes secciones describen atributos, elementos secundarios y elementos primarios.

Atributos

Atributo	Descripción
SubType	Atributo opcional. Especifica el subtipo de un elemento en una plantilla de elementos de varios archivos.Este valor se usa para determinar el editor que utilizará Visual Studio para abrir el elemento.
CustomTool	Atributo opcional. Establece CustomTool para el elemento en el archivo de proyecto.
ItemType	Atributo opcional. Establece ItemType para el elemento en el archivo de proyecto.
ReplaceParameters	Atributo opcional. Un 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.
TargetFileName	Atributo opcional. Especifica el nombre del elemento que se crea a partir de la plantilla.Este atributo resulta útil para utilizar la sustitución de parámetros para crear un nombre de elemento.

Elementos secundarios

Ninguno.

Elementos primarios

Elemento	Descripción
TemplateContent	Especifica el contenido de la plantilla.

Valor de texto

Se requiere un valor de texto.

string que representa el nombre de un archivo del archivo .zip de plantillas.

Comentarios

ProjectItem es un elemento opcional de TemplateContent.

El atributo TargetFileName se puede utilizar para cambiar el nombre de los archivos con parámetros.Por ejemplo, si existe el archivo MyFile.vb en el directorio raíz del archivo .zip de plantillas, pero desea que se le asigne al archivo un nombre basado en el nombre de archivo facilitado por el usuario en el cuadro de diálogo Agregar nuevo elemento, utilizaría el siguiente código XML:

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

Cuando se crea un elemento a partir de esta plantilla, el nombre de archivo se basará en el nombre del usuario especificado en el cuadro de diálogo Agregar nuevo elemento.Esto es útil al crear plantillas de elementos de varios archivos.Para obtener más información, vea Cómo: Crear plantillas de elementos de varios archivos y Parámetros de plantilla.

Ejemplo

En el ejemplo siguiente se muestran los metadatos de una plantilla de elementos estándar de una clase de Visual C#.

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

Vea también

Tareas

Cómo: Crear plantillas de elementos de varios archivos

Referencia

Referencia de esquema de plantillas de Visual Studio

Conceptos

Introducción a las plantillas de Visual Studio

Parámetros de plantilla