Créer des modèles d’élément

  • Article

Cet article vous montre comment créer un modèle d’élément à l’aide de l’Assistant Exportation de modèle. Si votre modèle comprend plusieurs fichiers, consultez Guide pratique pour créer des modèles d’élément multifichiers.

Ajouter un modèle d’élément à la boîte de dialogue Ajouter un nouvel élément

  1. Créez ou ouvrez un projet dans Visual Studio.

  2. Ajoutez un élément au projet et modifiez-le si vous le souhaitez.

  3. Modifiez le fichier de code pour indiquer où le remplacement de paramètres doit avoir lieu. Pour plus d’informations, consultez Guide pratique pour substituer des paramètres dans un modèle.

  4. Dans le menu Projet, choisissez Exporter le modèle.

  5. Dans la page Choisir un type de modèle choisissez Modèle d’élément, sélectionnez le projet qui contient l’élément, puis choisissez Suivant.

  6. Dans la page Sélectionner l’élément à exporter, choisissez l’élément pour lequel créer un modèle, puis choisissez Suivant.

  7. Dans la page Sélectionner les références aux éléments, sélectionnez les références d’assembly à inclure dans le modèle, puis choisissez Suivant.

  8. Dans la page Sélectionner les options du modèle, entrez le nom du modèle et éventuellement une description, une image d’icône et une image d’aperçu, puis choisissez Terminer.

    Les fichiers du modèle sont ajoutés à un fichier .zip et copiés dans le répertoire que vous avez spécifié dans l’Assistant. L’emplacement par défaut est : %USERPROFILE%\Documents\Visual Studio <version>\My Exported Templates.

  9. Si vous n’avez pas sélectionné l’option Importer automatiquement le modèle dans Visual Studio dans l’Assistant Exportation de modèle, recherchez le modèle exporté. Copiez-le ensuite dans le répertoire des modèles d’éléments utilisateur. L’emplacement par défaut est : %USERPROFILE%\Documents\Visual Studio <version>\Templates\ItemTemplates.

  10. Fermez Visual Studio, puis rouvrez-le.

  11. Créez un projet ou ouvrez un projet existant, puis choisissez Projet>Ajouter un nouvel élément, ou appuyez sur Ctrl+Maj+A.

    Le modèle d’élément apparaît dans la boîte de dialogue Ajouter un nouvel élément. Si vous avez ajouté une description dans l’Assistant Exportation de modèle, la description s’affiche dans la partie droite de la boîte de dialogue.

Permettre l’utilisation du modèle d’élément dans un projet d’application Windows universel

L’Assistant effectue une grande partie du travail nécessaire à la création d’un modèle de base, mais dans de nombreux cas, vous devez modifier manuellement le fichier .vstemplate après avoir exporté le modèle. Par exemple, si vous souhaitez que l’élément s’affiche dans la boîte de dialogue Ajouter un nouvel élément pour un projet d’application Windows universelle, vous devez effectuer quelques étapes supplémentaires.

  1. Suivez les étapes de la section précédente pour exporter un modèle d’élément.

  2. Extrayez le fichier .zip créé, puis ouvrez le fichier .vstemplate dans Visual Studio.

  3. Pour un projet Windows universel C#, ajoutez le code XML suivant à l’intérieur de l’élément <TemplateData> :

    <TemplateID>Microsoft.CSharp.Class</TemplateID>

  4. Dans Visual Studio, enregistrez le fichier .vstemplate, puis fermez-le.

  5. Copiez et collez le fichier .vstemplate dans le fichier .zip d’origine.

    Si la boîte de dialogue Copier le fichier apparaît, sélectionnez l’option Copier et remplacer.

Vous pouvez maintenant ajouter un élément basé sur ce modèle à un projet Windows universel à partir de la boîte de dialogue Ajouter un nouvel élément.

Activer des modèles pour des sous-types de projet spécifiques

Vous pouvez spécifier que votre modèle doit uniquement apparaître pour certains sous-types de projet, comme Windows, Office, Base de données ou Web.

  1. Localisez l’élément ProjectType dans le fichier .vstemplate du modèle d’élément.

  2. Ajoutez un élément ProjectSubType juste après l’élément ProjectType.

  3. Affectez au texte de l'élément l'une des valeurs suivantes :

    • Windows
    • Office
    • Base de données
    • Web

Par exemple : <ProjectSubType>Database</ProjectSubType>.

L’exemple suivant présente un modèle d’élément disponible pour les projets Office.

<VSTemplate Version="2.0.0" Type="Item" Version="2.0.0">
   <TemplateData>
      <Name>Class</Name>
      <Description>An empty class file</Description>
      <Icon>Class.ico</Icon>
      <ProjectType>CSharp</ProjectType>
      <ProjectSubType>Office</ProjectSubType>
      <DefaultName>Class.cs</DefaultName>
   </TemplateData>
   <TemplateContent>
      <ProjectItem>Class1.cs</ProjectItem>
   </TemplateContent>
</VSTemplate>

Créer manuellement un modèle d’élément

Dans certains cas, vous pouvez avoir envie de créer un modèle d’élément manuellement, à partir de zéro.

  1. Créez un projet et un élément de projet.

  2. Modifiez l'élément de projet jusqu'à ce qu'il soit prêt à être enregistré en tant que modèle.

  3. Modifiez le fichier de code pour indiquer où le remplacement de paramètres doit avoir lieu, le cas échéant. Pour plus d’informations sur le remplacement de paramètres, consultez Guide pratique pour substituer des paramètres dans un modèle.

  4. Créez un fichier XML et enregistrez-le avec l’extension de nom de fichier .vstemplate dans le même répertoire que votre fichier d’élément de projet.

  5. Modifiez le fichier XML .vstemplate pour fournir des métadonnées de modèle d’élément. Pour plus d’informations, consultez Informations de référence sur les schémas de modèles (extensibilité), ainsi que l’exemple de la section précédente.

  6. Enregistrez le fichier .vstemplate, puis fermez-le.

  7. Dans l’Explorateur Windows, sélectionnez les fichiers à inclure dans votre modèle. Cliquez avec le bouton droit sur la sélection, puis choisissez Envoyer vers>Dossier compressé. Les fichiers que vous avez sélectionnés sont compressés dans un fichier .zip.

  8. Copiez le fichier .zip, puis collez-le à l’emplacement du modèle d’élément utilisateur. Le répertoire par défaut est %USERPROFILE%\Documents\Visual Studio 2022\Templates\ItemTemplates. Pour plus d’informations, consultez Guide pratique pour localiser et organiser les modèles de projet et d’élément.

Contenu connexe