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

Spécifie un fichier qui est inclus dans le modèle de projet.Specifies a file that is included in the project template.

Note

Le ProjectItem élément accepte des attributs différents selon que le modèle est pour un projet ou un élément.The ProjectItem element accepts different attributes depending on whether the template is for a project or an item. Cette rubrique explique les ProjectItem , élément pour les modèles de projet.This topic explains the ProjectItem element for project templates. Pour obtenir une explication de la ProjectItem , élément pour les modèles d’élément, consultez ProjectItem, élément (modèles d’élément Visual Studio).For an explanation of the ProjectItem element for item templates, see ProjectItem Element (Visual Studio Item Templates).

<VSTemplate ><VSTemplate>
<TemplateContent ><TemplateContent>
<Project><Project>
<ProjectItem ><ProjectItem>

SyntaxeSyntax

<ProjectItem  
    TargetFileName="TargetFileName.ext"  
    ReplaceParameters="true/false"  
    OpenInEditor="true/false"  
    OpenInWebBrowser="true/false"  
    OpenInHelpBrowser="true/false"  
    OpenOrder="Value">  
        FileName.ext  
</ProjectItem>  

Attributs et élémentsAttributes and Elements

Les sections suivantes décrivent des attributs, des éléments enfants et des éléments parents.The following sections describe attribute, child elements, and parent elements.

AttributsAttributes

AttributAttribute DescriptionDescription
TargetFileName Attribut facultatif.Optional attribute.

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.Specifies the name and path of the project item when a project is created from the template. Cet attribut est utile pour la création d’une structure de répertoires différente de la structure de répertoires dans le fichier .zip du modèle, ou pour utiliser le remplacement de paramètre pour créer un nom d’élément.This attribute is useful for creating a directory structure different from the directory structure in the template .zip file, or for using parameter replacement to create an item name.
ReplaceParameters Attribut facultatif.Optional attribute.

Valeur booléenne qui spécifie si l’élément a les valeurs de paramètre qui doivent être remplacés lorsqu’un projet est créé à partir du modèle.A Boolean value that specifies whether the item has parameter values that must be replaced when a project is created from the template. La valeur par défaut est false.Default value is false.
OpenInEditor Attribut facultatif.Optional attribute.

Valeur booléenne qui spécifie si l’élément doit être ouvert dans son éditeur respectif dans Visual StudioVisual Studio lorsqu’un projet est créé à partir du modèle.A Boolean value that specifies whether the item should be opened in its respective editor in Visual StudioVisual Studio when a project is created from the template.

Le OpenInWebBrowser et OpenInHelpBrowser attributs ignorés sur un élément avec un OpenInEditor valeur true.The OpenInWebBrowser and OpenInHelpBrowser attributes are ignored on an item with an OpenInEditor value of true.

La valeur par défaut est false.The default value is false.
OpenInWebBrowser Attribut facultatif.Optional attribute.

Valeur booléenne qui spécifie si l’élément doit être ouvert le navigateur Web lorsqu’un projet est créé à partir du modèle.A Boolean value that specifies whether the item should be opened the Web browser when a project is created from the template.

Uniquement les fichiers HTML et les fichiers texte locaux du projet peuvent être ouverts dans le navigateur Web.Only HTML files and text files that are local to the project can be opened in the Web browser. URL externes ne peut pas être ouvert avec cet attribut.External URLs cannot be opened with this attribute.

La valeur par défaut est false.The default value is false.
OpenInHelpBrowser Attribut facultatif.Optional attribute.

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.A Boolean value that specifies whether the item should be opened in the Help viewer when a project is created from the template.

Uniquement les fichiers HTML et les fichiers texte locaux du projet peuvent être ouverts dans le navigateur d’aide.Only HTML files and text files that are local to the project can be opened in the Help browser. URL externes ne peut pas être ouvert avec cet attribut.External URLs cannot be opened with this attribute.

La valeur par défaut est false.The default value is false.
OpenOrder Attribut facultatif.Optional attribute.

Spécifie une valeur numérique qui représente l’ordre que les éléments seront ouverts dans leurs éditeurs respectifs.Specifies a numeric value that represents the order that items will be opened in their respective editors. Toutes les valeurs doivent être des multiples de 10.All values must be multiples of 10. Les éléments avec une valeur supérieure OpenOrder valeurs sont ouverts en premier.Items with higher OpenOrder values are opened first.

Éléments enfantsChild Elements

Aucun.None.

Éléments parentsParent Elements

ÉlémentElement DescriptionDescription
ProjetProject Spécifie les fichiers ou répertoires à ajouter au projet.Specifies the files or directories to add to the project.

Valeur texteText Value

Une valeur texte est requise.A text value is required.

Un string qui représente le nom ou le chemin d’accès à un fichier dans le fichier .zip du modèle.A string that represents the name or path to a file in the template .zip file.

NotesRemarks

ProjectItem est un enfant facultatif de Project.ProjectItem is an optional child of Project.

Le TargetFileName attribut 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.The TargetFileName attribute can be used to create a directory structure different from the directory structure in the template .zip file. Par exemple, si le fichier MyFile.vb existe à la racine du fichier .zip du modèle, mais vous souhaitez que le fichier doit être placé dans un répertoire nommé CustomFiles dans tous les projets créés à partir du modèle, vous utiliseriez le code XML suivant :For example, if the file MyFile.vb exists in the root of the template .zip file, but you want the file to be placed in a directory named CustomFiles in all projects created from the template, you would use the following XML:

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

Le TargetFileName attribut peut également être utilisé pour renommer des fichiers qui contiennent des caractères internationaux.The TargetFileName attribute can also be used to rename files that contain international characters in their filenames. Par exemple, un fichier .zip du modèle ne peut pas contenir des noms de fichiers avec des caractères Unicode, donc le fichier doit être renommé avant qu’il peut être compressé dans un fichier .zip.For example, a template .zip file cannot contain file names with Unicode characters, so the file must be renamed before it can be compressed into a .zip file. Le TargetFileName attribut peut être utilisé pour définir le nom du fichier vers le nom de fichier Unicode d’origine.The TargetFileName attribute can be used to set the file name back to the original Unicode file name.

Le TargetFileName attribut peut également être utilisé pour renommer des fichiers avec des paramètres.The TargetFileName attribute can also be used to rename files with parameters. La procédure suivante explique comment renommer le fichier MyFile.vb, qui existe dans le répertoire racine du fichier .zip du modèle, à un nom de fichier basé sur le nom du projet.The following procedure explains how to rename the file MyFile.vb, which exists in the root directory of the template .zip file, to a file name based on the project name.

Pour renommer des fichiers avec des paramètresTo rename files with parameters

  1. Dans le fichier .vstemplate, utilisez le code XML suivant :Use the following XML in the .vstemplate file:

    <ProjectItem TargetFileName="$safeprojectname$.vb">MyFile.vb</ProjectItem>  
    
  2. Ouvrez le fichier projet (.vbproj pour un Visual BasicVisual Basic projet) dans un éditeur de texte ou Visual StudioVisual Studio.Open the project file (.vbproj for a Visual BasicVisual Basic project) in a text editor or Visual StudioVisual Studio.

  3. Recherchez la ligne dans le fichier projet qui ressemble au code XML suivant :Locate the line in the project file that looks similar to the following XML:

    <Compile Include="MyFile.vb">  
    
  4. Remplacez la ligne de code avec le code XML suivant :Replace the line of code with the following XML:

    <Compile Include="$safeprojectname$.vb">  
    

    Lorsqu’un projet est créé à partir de ce modèle, le nom de fichier doit reposer sur le nom de l’utilisateur a entré dans le nouveau projet boîte de dialogue, avec tous les caractères non sécurisés et supprimés les espaces.When a project is created from this template, the file name will be based on the name the user entered in the New Project dialog box, with all unsafe characters and spaces removed. Pour plus d’informations, consultez les paramètres de modèle.For more information, see Template Parameters.

ExempleExample

L’exemple suivant affiche les métadonnées d’un modèle de projet pour un Visual C#Visual C# application.The following example shows the metadata for a project template for a Visual C#Visual C# application.

<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>  

Voir aussiSee Also

Référence du schéma de modèle Visual Studio Visual Studio Template Schema Reference
Création de modèles de projet et d’élément Creating Project and Item Templates
Paramètres de modèle Template Parameters
Élément ProjectItem (modèles d'élément Visual Studio)ProjectItem Element (Visual Studio Item Templates)