ProjectItem (Elemento, Plantillas de elementos de Visual Studio)

Artículo
01/13/2024

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

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 el elemento. Para obtener una explicación del elemento para las ProjectItem plantillas de proyecto, vea Elemento ProjectItem (plantillas de proyecto de Visual Studio).

Sintaxis

<ProjectItem
    SubType="Form/Component/CustomControl/UserControl"
    CustomTool="string"
    ItemType="string"
    ReplaceParameters="true/false"
    TargetFileName="TargetFileName.ext">
        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
`SubType`	Atributo opcional. Especifica el subtipo de un elemento en una plantilla de elemento de varios archivos. Este valor se usa para determinar el editor que Visual Studio usará 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 del proyecto.
`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`.
`TargetFileName`	Atributo opcional. Especifica el nombre del elemento que se crea a partir de la plantilla. Este atributo es útil para usar el reemplazo 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.

que string representa el nombre de un archivo en el archivo .zip de plantilla.

Comentarios

ProjectItem es un elemento secundario opcional de TemplateContent.

El TargetFileName atributo se puede usar para cambiar el nombre de los archivos con parámetros. Por ejemplo, si el archivo MyFile.vb existe en el directorio raíz del archivo .zip de plantilla, pero quiere que el archivo se asigne un nombre basado en el nombre de archivo proporcionado por el usuario en el cuadro de diálogo Agregar nuevo elemento, usará el siguiente 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 que escribió el usuario en el cuadro de diálogo Agregar nuevo elemento . Esto resulta útil al crear plantillas de elementos de varios archivos. Para obtener más información, vea How to: Create multi-file item templates and Template parameters.

Ejemplo

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

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