Comment : empaqueter des composants pour utiliser le programme d'installation de contenu Visual Studio

Article
08/10/2011

Le programme d'installation de contenu Visual Studio permet de déployer des macros, des compléments et des extraits de code pour étendre Visual Studio. Pour plus d'informations sur les autres stratégies de déploiement, consultez Visual Studio Extension Deployment.

Pour installer une extension à l'aide du programme d'installation de contenu Visual Studio, regroupez l'extension dans un fichier .vsi, généralement appelé composant de communauté. Le Programme d'installation de contenu Visual Studio copie automatiquement les éléments des composants de communauté vers les répertoires appropriés de l'ordinateur du développeur, afin que ces éléments figurent dans les boîtes de dialogue appropriées de Visual Studio.

Pour utiliser le Programme d'installation de contenu Visual Studio afin d'installer les composants destinés à la communauté, vous devez créer pour ceux-ci un fichier .vscontent. Une fois le fichier .vscontent créé, compressez les fichiers du composant et le fichier .vscontent dans un fichier .zip, puis modifiez l'extension de ce dernier de .zip en .vsi. Vous pouvez distribuer ensuite le fichier .vsi à d'autres développeurs qui utilisent n'importe quelle méthode que vous choisissez, par exemple rendre le fichier téléchargeable à partir du Web, l'envoyer comme pièce jointe dans un courrier électronique ou le publier sur un partage réseau.

Fichiers .vscontent

Les fichiers .vscontent utilisent le langage XML basé sur le Référence du schéma du programme d'installation de contenu Visual Studio pour décrire des composants que vous avez créés et que vous prévoyez de partager. Au minimum, le fichier .vscontent identifie le genre de composants et la version de Visual Studio avec laquelle les composants doivent être utilisés. Après avoir créé un fichier .vscontent, vous pouvez créer le fichier .vsi que le programme d'installation de contenu de Visual Studio utilisera pour installer les composants sur l'ordinateur d'un développeur.

Pour créer un fichier .vscontent de base

Dans le menu Fichier, pointez sur Nouveau, puis cliquez sur Fichier.
Dans la catégorie Général, sélectionnez Fichier XML puis cliquez sur Ouvrir.
Créez un fichier .vscontent valide à l'aide de Référence du schéma du programme d'installation de contenu Visual Studio.

Notes

Un exemple XML pour les fichiers .vscontent se trouve dans les sections Exemple de cette rubrique.
Enregistrez le fichier .vscontent dans le même répertoire que les autres fichiers liés au composant de communauté.

Fichiers .VSI

Les fichiers du Programme d'installation de contenu Visual Studio (.vsi) sont utilisés pour échanger un contenu Visual Studio au sein de la communauté des développeurs. Un fichier .vsi est un fichier .zip renommé qui contient les éléments suivants :

Fichier .vscontent XML qui décrit le composant de communauté.
Les fichiers pour le composant.

Le Programme d'installation de contenu Visual Studio utilise des fichiers .vsi pour installer un contenu partagé à un emplacement approprié. Pour plus d'informations sur l'installation de fichiers .vsi, consultez Comment : trouver et installer des composants de communauté.

Quelques fonctionnalités du Programme d'installation de contenu de Visual Studio nécessitent des outils supplémentaires ou des services à implémenter.

Afin d'afficher les informations sur l'éditeur pour le composant de communauté dans le Programme d'installation de contenu Visual Studio, vous devez signer le fichier .vsi. Pour plus d'informations, consultez Services de chiffrement.
Pour afficher un Contrat de Licence Utilisateur Final (CLUF) dans le Programme d'installation de contenu Visual Studio, vous devez intégrer cette information au fichier .zip. WinZip prend en charge l'inclusion d'informations incorporées à travers la fonctionnalité Commentaire. Pour plus d'informations sur WinZip, consultez http://www.winzip.com. Pour plus d'informations sur la fonctionnalité Commentaire, consultez le fichier d'aide de WinZip.

Pour créer un fichier .vsi de base

Créez un fichier .vscontent valide pour le composant, si ce n'est déjà fait. Pour plus d'informations, consultez la section Fichiers .VSCONTENT, plus haut dans cette rubrique.
Dans l'Explorateur Windows, sélectionnez les fichiers requis pour le composant, y compris le fichier .vscontent.
Cliquez avec le bouton droit sur les fichiers sélectionnés, pointez sur Envoyez vers, puis cliquez sur Dossier compressé.

Les fichiers sélectionnés sont compressés dans un seul fichier .zip.
Renommez l'extension du fichier .zip en .vsi.

Exemple

L'exemple suivant présente un fichier .vscontent destiné à un fichier .vsi qui contient un complément. L'élément <ContentVersion> a la valeur 2.0, ce qui signifie que le complément est uniquement compatible avec les versions 9.0 et 10.0 de Visual Studio.

Les fichiers suivants seraient inclus dans le fichier .vsi pour ce contenu :

Un fichier .vscontent qui contient le code XML indiqué dans cet exemple.
Fichier d'inscription de complément MyAddin.Addin.
Fichier .dll de complément MyAddin.dll compilé.

Les fichiers de complément sont installés dans le répertoire suivant :

n:\... \Mes documents\Visual Studio <version>\Addins\

Pour des exemples supplémentaires, consultez Comment : publier des modèles de projet et Comment : publier des extraits de code.

<VSContent xmlns="https://schemas.microsoft.com/developer/vscontent/2005"> 
    <Content>
        <FileName>MyAddin.Addin</FileName>
        <FileName>MyAddin.dll</FileName>
        <DisplayName>Example Add-in</DisplayName>
        <Description>An add-in created for this example.</Description>
        <FileContentType>Addin</FileContentType>
        <ContentVersion>2.0</ContentVersion>
    </Content>
</VSContent>

L'exemple suivant présente un fichier .vscontent pour un fichier .vsi qui contient un projet macro qui peut être utilisé avec les versions 8.0, 9.0 et 10.0 de Visual Studio. Les fichiers suivants seraient inclus dans le fichier .vsi pour ce contenu :

Un fichier .vscontent qui contient le code XML indiqué dans cet exemple.
Le fichier macro MyMacroProject.vsmacros.

Le fichier macro est installé dans le répertoire suivant :

n:\... \Mes documents\Visual Studio <version>\Projects\VSMacros80\

<VSContent xmlns="https://schemas.microsoft.com/developer/vscontent/2005">
    <Content>
        <FileName>MyMacroProject.vsmacros</FileName>
        <DisplayName>My Macro Project</DisplayName>
        <Description> A macro project created for this example.</Description>
        <FileContentType>Macro Project</FileContentType>
        <ContentVersion>1.0</ContentVersion>
    </Content>
</VSContent>