Partage via

Empaqueter et déployer des extensions My personnalisées (Visual Basic)

Visual Basic vous permet de déployer facilement vos extensions d’espace de noms personnalisées My à l’aide de modèles Visual Studio. Si vous créez un modèle de projet pour lequel vos My extensions font partie intégrante du nouveau type de projet, vous pouvez simplement inclure votre code d’extension personnalisé My avec le projet lorsque vous exportez le modèle. Pour plus d’informations sur l’exportation de modèles de projet, consultez Guide pratique pour créer des modèles de projet.

Si votre extension personnalisée My se trouve dans un fichier de code unique, vous pouvez exporter le fichier en tant que modèle d’élément que les utilisateurs peuvent ajouter à n’importe quel type de projet Visual Basic. Vous pouvez ensuite personnaliser le modèle d’élément pour activer des fonctionnalités et un comportement supplémentaires pour votre extension personnalisée My dans un projet Visual Basic. Ces fonctionnalités sont les suivantes :

  • Permettre aux utilisateurs de gérer votre extension personnalisée My à partir de la page Mes extensions du Concepteur de projets Visual Basic.

  • Ajout automatique de votre extension personnalisée My lorsqu’une référence à un assembly spécifié est ajoutée à un projet.

  • Masquage du My modèle d’élément d’extension dans la boîte de dialogue Ajouter un élément afin qu’il ne soit pas inclus dans la liste des éléments de projet.

Cette rubrique explique comment empaqueter une extension personnalisée My en tant que modèle d’élément masqué qui peut être géré à partir de la page Mes extensions du Concepteur de projets Visual Basic. L’extension personnalisée My peut également être ajoutée automatiquement lorsqu’une référence à un assembly spécifié est ajoutée à un projet.

Créer une extension d’espace de noms My

La première étape de la création d’un package de déploiement pour une extension personnalisée My consiste à créer l’extension en tant que fichier de code unique. Pour plus d’informations et des conseils sur la création d’une extension personnalisée My , consultez Extension de l’espace de noms My en Visual Basic.

Exporter une extension d’espace de noms My en tant que modèle d’élément

Une fois que vous avez un fichier de code qui inclut votre My extension d’espace de noms, vous pouvez exporter le fichier de code en tant que modèle d’élément Visual Studio. Pour obtenir des instructions sur l’exportation d’un fichier en tant que modèle d’élément Visual Studio, consultez Guide pratique pour créer des modèles d’élément.

Remarque

Si votre My extension d’espace de noms a une dépendance sur un assembly particulier, vous pouvez personnaliser votre modèle d’élément pour installer automatiquement votre My extension d’espace de noms lorsqu’une référence à cet assembly est ajoutée. Par conséquent, vous souhaiterez exclure cette référence d’assembly lorsque vous exportez le fichier de code en tant que modèle d’élément Visual Studio.

Personnaliser le modèle d’élément

Vous pouvez activer la gestion de votre modèle d’élément à partir de la page Mes extensions du Concepteur de projets Visual Basic. Vous pouvez également activer l’ajout automatique du modèle d’élément lorsqu’une référence à un assembly spécifié est ajoutée à un projet. Pour activer ces personnalisations, vous allez ajouter un nouveau fichier, appelé fichier CustomData, à votre modèle, puis ajouter un nouvel élément au code XML dans votre fichier .vstemplate.

Ajouter le fichier CustomData

Le fichier CustomData est un fichier texte qui a une extension de nom de fichier de . CustomData (le nom de fichier peut être défini sur n’importe quelle valeur significative pour votre modèle) et qui contient du code XML. Le code XML du fichier CustomData indique à Visual Basic d’inclure votre My extension lorsque les utilisateurs utilisent la page Mes extensions du Concepteur de projets Visual Basic. Vous pouvez éventuellement ajouter l’attribut <AssemblyFullName> à votre fichier CustomData XML. Cela indique à Visual Basic d’installer automatiquement votre extension personnalisée My lorsqu’une référence à un assembly particulier est ajoutée au projet. Vous pouvez utiliser n’importe quel éditeur de texte ou éditeur XML pour créer le fichier CustomData, puis l’ajouter au dossier compressé de votre modèle d’élément (fichier.zip).

Par exemple, le code XML suivant montre le contenu d’un fichier CustomData qui ajoute l’élément de modèle au dossier Mes extensions d’un projet Visual Basic lorsqu’une référence à l’assembly Microsoft.VisualBasic.PowerPacks.Vs.dll est ajoutée au projet.

<VBMyExtensionTemplate
    ID="Microsoft.VisualBasic.Samples.MyExtensions.MyPrinterInfo"
    Version="1.0.0.0"
    AssemblyFullName="Microsoft.VisualBasic.PowerPacks.vs"
/>

Le fichier CustomData contient un <VBMyExtensionTemplate> élément qui a des attributs, comme indiqué dans le tableau suivant.

Caractéristique Descriptif
ID Obligatoire. Identificateur unique de l’extension. Si l’extension dont cet ID a déjà été ajouté au projet, l’utilisateur ne sera pas invité à l’ajouter à nouveau.
Version Obligatoire. Numéro de version du modèle d’élément.
AssemblyFullName Optionnel. Nom d'assembly Lorsqu’une référence à cet assembly est ajoutée au projet, l’utilisateur est invité à ajouter l’extension My à partir de ce modèle d’élément.

Ajouter l’élément <CustomDataSignature> au fichier .vstemplate

Pour identifier votre modèle d’élément Visual Studio en tant qu'extension d’espace de noms My, vous devez également modifier le fichier .vstemplate correspondant à votre modèle d’élément. Vous devez ajouter un <CustomDataSignature> élément à l’élément <TemplateData> . L’élément <CustomDataSignature> doit contenir le texte Microsoft.VisualBasic.MyExtension, comme illustré dans l’exemple suivant.

<CustomDataSignature>Microsoft.VisualBasic.MyExtension</CustomDataSignature>

Vous ne pouvez pas modifier les fichiers dans un dossier compressé (fichier.zip) directement. Vous devez copier le fichier .vstemplate à partir du dossier compressé, le modifier, puis remplacer le fichier .vstemplate dans le dossier compressé par votre copie mise à jour.

L’exemple suivant montre le contenu d’un fichier .vstemplate qui a ajouté l’élément <CustomDataSignature> .

<VSTemplate Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">
  <TemplateData>
    <DefaultName>MyCustomExtensionModule.vb</DefaultName>
    <Name>MyPrinterInfo</Name>
    <Description>Custom My Extensions Item Template</Description>
    <ProjectType>VisualBasic</ProjectType>
    <SortOrder>10</SortOrder>
    <Icon>__TemplateIcon.ico</Icon>
    <CustomDataSignature      >Microsoft.VisualBasic.MyExtension</CustomDataSignature>
  </TemplateData>
  <TemplateContent>
    <References />
    <ProjectItem SubType="Code"
                 TargetFileName="$fileinputname$.vb"
                 ReplaceParameters="true"
     >MyCustomExtensionModule.vb</ProjectItem>
  </TemplateContent>
</VSTemplate>

Installer le modèle

Pour installer le modèle, vous pouvez copier le dossier compressé ( fichier.zip ) dans le dossier modèles d’éléments Visual Basic. Par défaut, les modèles d’élément utilisateur se trouvent dans %USERPROFILE%\Documents\Visual Studio <Version>\Templates\ItemTemplates\Visual Basic. Vous pouvez également publier le modèle en tant que fichier Visual Studio Installer (.vsi).

Voir aussi

  • Last updated on