ProjectItem, élément (modèles d’élément Visual Studio)

Article
10/10/2023

Spécifie un fichier inclus dans le modèle d’élément.

Remarque

L’élément ProjectItem accepte différents attributs selon que le modèle est destiné à un projet ou à un élément. Cette rubrique explique l’élément de l’élément pour l’élément ProjectItem . Pour obtenir une explication de l’élément pour les ProjectItem modèles de projet, consultez l’élément ProjectItem (modèles de projet Visual Studio).

Syntaxe

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

Attributs et éléments

Les sections suivantes décrivent des attributs, des éléments enfants et des éléments parents.

Attributs

Attribut	Description
`SubType`	Attribut facultatif. Spécifie le sous-type d’un élément dans un modèle d’élément à plusieurs fichiers. Cette valeur est utilisée pour déterminer l’éditeur que Visual Studio utilisera pour ouvrir l’élément.
`CustomTool`	Attribut facultatif. Définit CustomTool pour l’élément dans le fichier projet.
`ItemType`	Attribut facultatif. Définit itemType pour l’élément dans le fichier projet.
`ReplaceParameters`	Attribut facultatif. Valeur booléenne qui spécifie si l’élément a des valeurs de paramètre qui doivent être remplacées lorsqu’un projet est créé à partir du modèle. La valeur par défaut est `false`.
`TargetFileName`	Attribut facultatif. Spécifie le nom de l’élément créé à partir du modèle. Cet attribut est utile pour utiliser le remplacement de paramètre pour créer un nom d’élément.

Éléments enfants

Aucune.

Éléments parents

Élément	Description
TemplateContent	Spécifie le contenu du modèle.

Valeur texte

Une valeur texte est requise.

Qui string représente le nom d’un fichier dans le fichier .zip du modèle.

Notes

ProjectItem est un enfant facultatif de TemplateContent.

L’attribut TargetFileName peut être utilisé pour renommer des fichiers avec des paramètres. Par exemple, si le fichier MyFile.vb existe dans le répertoire racine du fichier .zip de modèle, mais que vous souhaitez que le fichier soit nommé en fonction du nom de fichier fourni par l’utilisateur dans la boîte de dialogue Ajouter un nouvel élément, vous devez utiliser le code XML suivant :

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

Lorsqu’un élément est créé à partir de ce modèle, le nom de fichier est basé sur le nom entré par l’utilisateur dans la boîte de dialogue Ajouter un nouvel élément . Cela est utile lors de la création de modèles d’éléments à plusieurs fichiers. Pour plus d’informations, consultez How to : Create multi-file item templates and Template parameters.

Exemple

L’exemple suivant illustre les métadonnées du modèle d’élément standard pour une classe 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>