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

Article
10/10/2023

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

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 pour les ProjectItem modèles de projet. Pour obtenir une explication de l’élément pour les ProjectItem modèles d’éléments, consultez ProjectItem, élément (modèles d’élément Visual Studio).

Syntaxe

<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 la structure de répertoires dans le fichier .zip de 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 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`.
`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 `OpenInWebBrowser` attributs et `OpenInHelpBrowser` les attributs sont ignorés sur un élément avec une `OpenInEditor` valeur de `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 les fichiers texte locaux au 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 d’aide lorsqu’un projet est créé à partir du modèle. Seuls les fichiers HTML et les fichiers texte locaux au 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 dont les valeurs sont supérieures `OpenOrder` sont ouverts en premier.

Éléments enfants

Aucune.

Éléments parents

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

Valeur texte

Une valeur texte est requise.

Qui string représente le nom ou le chemin d’accès à un fichier dans le fichier .zip du modèle.

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 dans le fichier .zip du modèle. Par exemple, si le fichier MyFile.vb existe à la racine du fichier .zip de modèle, mais que vous souhaitez que le fichier soit placé dans un répertoire nommé CustomFiles dans tous les projets créés à partir du modèle, vous utilisez le code XML suivant :

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

L’attribut TargetFileName peut également être utilisé pour renommer des fichiers qui contiennent des caractères internationaux dans leurs noms de fichiers. Par exemple, un fichier .zip de modèle ne peut pas contenir de noms de fichiers avec des caractères Unicode. Le fichier doit donc être renommé avant de pouvoir être compressé dans un fichier .zip. L’attribut TargetFileName peut être utilisé pour définir le nom de fichier sur le nom de fichier Unicode d’origine.

L’attribut TargetFileName peut également être utilisé pour renommer des fichiers avec des paramètres. La procédure suivante explique comment renommer le fichier MyFile.vb, qui existe dans le répertoire racine du fichier .zip de modèle, 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 dans le fichier projet qui ressemble au code XML suivant :
```
<Compile Include="MyFile.vb">
```
Remplacez la ligne de code par le code XML suivant :
```
<Compile Include="$safeprojectname$.vb">
```
Lorsqu’un projet 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 Nouveau projet , avec tous les caractères et espaces non sécurisés supprimés. Pour plus d’informations, consultez Paramètres de modèle.

Exemple

L’exemple suivant montre les métadonnées d’un modèle de projet pour une application 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>

Partager via