ProjectItem, élément (modèles de projet Visual Studio)

Article
06/10/2015

Spécifie un fichier inclus dans le modèle de projet.

Notes

L'élément ProjectItem accepte des attributs différents selon que le modèle concerne un projet ou un élément.Cette rubrique explique l'élément ProjectItem des modèles de projet.Pour une explication de l'élément ProjectItem dans le cas de modèles d'élément, consultez ProjectItem, élément (modèles d'élément Visual Studio).

<ProjectItem
    TargetFileName="TargetFileName.ext"
    ReplaceParameters="true/false"
    OpenInEditor="true/false"
    OpenInWebBrowser="true/false"
    OpenInHelpBrowser="true/false"
    OpenOrder="Value">
        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
TargetFileName	Attribut facultatif. Spécifie le nom et le chemin d'accès de l'élément de projet lorsqu'un projet est créé à partir du modèle. Cet attribut est utile pour créer une structure de répertoires différente de celle du fichier .zip du modèle ou pour utiliser le remplacement de paramètre pour créer un nom d'élément.
ReplaceParameters	Attribut facultatif. Valeur booléenne qui spécifie si l'élément contient des paramètres dont les valeurs doivent être remplacées lorsqu'un projet est créé à partir du modèle. La valeur par défaut est false
OpenInEditor	Attribut facultatif. Valeur booléenne qui spécifie si l'élément doit être ouvert dans son éditeur respectif dans Visual Studio lorsqu'un projet est créé à partir du modèle. Les attributs OpenInWebBrowser et OpenInHelpBrowser sont ignorés sur un élément dont OpenInEditor a la valeur true. La valeur par défaut est false.
OpenInWebBrowser	Attribut facultatif. Valeur booléenne qui spécifie si l'élément doit être ouvert dans le Navigateur Web lorsqu'un projet est créé à partir du modèle. Seuls les fichiers HTML et fichiers texte locaux du projet peuvent être ouverts dans le Navigateur Web. Les URL externes ne peuvent pas être ouvertes avec cet attribut. La valeur par défaut est false.
OpenInHelpBrowser	Attribut facultatif. Valeur booléenne qui spécifie si l'élément doit être ouvert dans la visionneuse de l'aide lorsqu'un projet est créé à partir du modèle. Seuls les fichiers HTML et texte locaux du projet peuvent être ouverts dans le navigateur d'aide. Les URL externes ne peuvent pas être ouvertes avec cet attribut. La valeur par défaut est false.
OpenOrder	Attribut facultatif. Spécifie une valeur numérique qui représente l'ordre dans lequel les éléments seront ouverts dans leurs éditeurs respectifs. Toutes les valeurs doivent être des multiples de 10. Les éléments avec des valeurs supérieures d' OpenOrder sont ouverts en premier.

Éléments enfants

Aucun

Éléments parents

Élément	Description
Projet	Spécifie les fichiers ou répertoires à ajouter au projet.

Valeur texte

Une valeur texte est requise.

string qui représente le nom d'un fichier contenu dans le fichier .zip du modèle, ou son chemin d'accès.

Notes

ProjectItem est un enfant facultatif de Project.

L'attribut TargetFileName peut être utilisé pour créer une structure de répertoires différente de la structure de répertoires du fichier .zip du modèle. Par exemple, si le fichier MyFile.vb existe à la racine du fichier .zip du modèle alors que vous souhaitez le placer dans un répertoire nommé CustomFiles dans tous les projets créés à partir du modèle, utilisez le XML suivant :

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

L'attribut TargetFileName peut également être utilisé pour renommer les fichiers dont le nom contient des caractères internationaux. Par exemple, un modèle de fichier .zip ne peut pas contenir de noms de fichiers avec des caractères Unicode ; par conséquent, le fichier doit être renommé pour pouvoir être compressé dans un fichier .zip. L'attribut TargetFileName peut être utilisé pour rétablir le nom de fichier Unicode d'origine.

L'attribut TargetFileName permet également de renommer des fichiers à l'aide de paramètres. La procédure suivante explique comment renommer le fichier MyFile.vb, qui existe dans le répertoire racine du fichier modèle .zip, en un nom de fichier basé sur le nom du projet.

Pour renommer des fichiers avec des paramètres

Utilisez le code XML suivant dans le fichier .vstemplate :

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

Ouvrez le fichier projet (.vbproj pour un projet Visual Basic ) dans un éditeur de texte ou Visual Studio.
Recherchez la ligne du fichier projet qui ressemble au code XML suivant :
```
<Compile Include="MyFile.vb">
```
Remplacez la ligne de code par la ligne XML suivante :
```
<Compile Include="$safeprojectname$.vb">
```
À la création d'un projet à partir de ce modèle, le fichier prend un nom basé sur celui que l'utilisateur a entré dans la boîte de dialogue Nouveau projet, et dont tous les caractères et espaces potentiellement dangereux ont été supprimés. Pour plus d’informations, consultez Paramètres de modèle.

Exemple

L'exemple suivant affiche les métadonnées d'un modèle de projet pour une application Visual C#.

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