Partager via

Entrées de Registre pour les compléments VSTO

  • Article

Vous devez créer un ensemble spécifique d'entrées de Registre quand vous déployez des compléments VSTO créés à l'aide de Visual Studio. Ces entrées de Registre fournissent des informations qui permettent à l'application Microsoft Office de découvrir et de charger le complément VSTO.

S’applique à : les informations contenues dans cette rubrique s’appliquent aux projets de complément VSTO. Pour plus d’informations, consultez Fonctionnalités disponibles par application Office lication et le type de projet.

Remarque

Vous souhaitez développer des solutions qui étendent l’expérience de Bureau sur plusieurs plateformes ? Consultez le nouveau modèle de compléments Bureau. Bureau compléments ont une petite empreinte par rapport aux compléments et solutions VSTO, et vous pouvez les créer à l’aide de presque n’importe quelle technologie de programmation web, telle que HTML5, JavaScript, CSS3 et XML.

Lorsque vous générez votre projet, Visual Studio crée ces entrées de Registre sur l’ordinateur de développement. Cela vous permet d’exécuter et de déboguer facilement le complément VSTO. À l’aide de ClickOnce pour déployer votre complément VSTO, les entrées de Registre sont automatiquement créées sur l’ordinateur de l’utilisateur final.

Pour plus d’informations sur le déploiement d’une solution VSTO à l’aide de Windows Installer, consultez Déploiement d’une solution VSTO à l’aide de Windows Installer.

Pour plus d’informations sur la façon dont les entrées de Registre sont utilisées pendant le processus de chargement des compléments VSTO, consultez Architecture of VSTO Add-ins.

Remarque

Dans cette rubrique, le texte ID du complément représente l'ID unique de votre complément VSTO. Par défaut, l'ID est le nom de l'assembly de votre complément VSTO.

Inscrire des compléments VSTO pour l’utilisateur actuel et tous les utilisateurs

Quand un complément VSTO est installé, il peut être inscrit de deux façons :

  • Pour l’utilisateur actuel uniquement (le complément VSTO est disponible uniquement pour l’utilisateur connecté à l’ordinateur lorsque le complément a été installé). Dans ce cas, les entrées de Registre sont créées sous le HKEY_CURRENT_USER.

  • Pour tous les utilisateurs (autrement dit, tout utilisateur qui se connecte à l’ordinateur peut utiliser le complément VSTO). Dans ce cas, les entrées de Registre sont créées sous HKEY_LOCAL_MACHINE.

    Tous les compléments VSTO que vous créez à l'aide de Visual Studio peuvent être inscrits pour l'utilisateur actuel. En revanche, ils ne peuvent être inscrits pour tous les utilisateurs que dans certains scénarios particuliers. Ces scénarios dépendent de la version de Microsoft Office installée sur l'ordinateur et de la façon dont le complément VSTO a été déployé.

Type de déploiement

Si vous utilisez ClickOnce pour déployer un complément VSTO, ce dernier ne peut être inscrit que pour l'utilisateur actuel. Cela est dû au fait que ClickOnce prend uniquement en charge la création de clés sous HKEY_CURRENT_USER. Si vous voulez inscrire un complément VSTO pour tous les utilisateurs d'un ordinateur, vous devez déployer ce complément à l'aide de Windows Installer. Pour plus d’informations sur ces types de déploiement, consultez Déployer une solution Bureau à l’aide de ClickOnce et déployer une solution Bureau à l’aide de Windows Installer.

Entrées du Registre

Les entrées de Registre de compléments VSTO requises se trouvent sous les clés de Registre suivantes où Root est HKEY_CURRENT_USER ou HKEY_LOCAL_MACHINE selon que l’installation est destinée à l’utilisateur actuel ou à tous les utilisateurs.

application Bureau Chemin d'accès de configuration
Visio Root\Software\Microsoft\Visio\Addins\add-in ID
Tous les autres Root\Software\Microsoft\Bureau\application Office lication name\Addins\add-in ID

Remarque

Si le programme d’installation cible tous les utilisateurs sur Windows 64 bits, il est recommandé d’inclure deux entrées de Registre, une sous HKEY_LOCAL_MACHINE\Software\Microsoft et une sous HKEY_LOCAL_MACHINE\Software\WOW6432Node\Microsoft hive. Cela est dû au fait qu’il est possible pour les utilisateurs d’utiliser des versions 32 bits ou 64 bits de Bureau sur l’ordinateur.

Si le programme d’installation cible l’utilisateur actuel, il n’est pas nécessaire d’installer sur wow6432Node, car le chemin d’accès HKEY_CURRENT_USER\Software est partagé.

Pour plus d’informations, consultez les données d’application 32 bits et 64 bits dans le Registre.

Le tableau suivant répertorie les entrées sous cette clé de Registre.

Entrée Type Value
Description REG_SZ Obligatoire. Brève description du complément VSTO.

Cette description s'affiche quand l'utilisateur sélectionne le complément VSTO dans le volet Compléments de la boîte de dialogue Options de l'application Microsoft Office.
FriendlyName REG_SZ Obligatoire. Nom descriptif du complément VSTO qui s'affiche dans la boîte de dialogue Compléments COM de l'application Microsoft Office. La valeur par défaut est l'ID du complément VSTO.
LoadBehavior REG_DWORD Obligatoire. Valeur qui spécifie le moment où l'application tente de charger le complément VSTO, ainsi que l'état actuel du complément VSTO (chargé ou non chargé).

Par défaut, cette entrée a la valeur 3, ce qui indique que le complément VSTO est chargé au démarrage. Pour plus d’informations, consultez les valeurs LoadBehavior.

Remarque : si un utilisateur désactive le complément VSTO, cette action modifie la valeur LoadBehavior dans la ruche du registre HKEY_CURRENT_USER . Pour chaque utilisateur, la valeur de la valeur LoadBehavior dans la ruche HKEY_CURRENT_USER remplace la valeur LoadBehavior par défaut définie dans la ruche HKEY_LOCAL_MACHINE.
Manifeste REG_SZ Obligatoire. Chemin d'accès complet du manifeste de déploiement du complément VSTO. Le chemin d'accès peut être un emplacement sur l'ordinateur local, un partage réseau (UNC) ou un serveur web (HTTP).

Si vous utilisez Windows Installer pour déployer la solution, vous devez ajouter le préfixe file:/// au chemin d'accès du manifeste . Vous devez également ajouter la chaîne |vstolocal (autrement dit, le caractère | de canal suivi de vstolocal) à la fin de ce chemin. Cela permet de garantir que votre solution est chargée à partir du dossier d'installation, et non à partir du cache ClickOnce. Pour plus d’informations, consultez Déployer une solution Bureau à l’aide de Windows Installer.

Remarque : Lorsque vous générez un complément VSTO sur l’ordinateur de développement, Visual Studio ajoute automatiquement la chaîne |vstolocal à cette entrée de Registre.

Entrées de Registre pour les zones de formulaire Outlook

Si vous créez une zone de formulaire personnalisée dans un complément VSTO pour Outlook, des entrées de Registre supplémentaires sont utilisées pour inscrire la zone de formulaire dans Outlook. Ces entrées sont créées sous une autre clé de Registre pour chaque classe de message prise en charge par la zone de formulaire. Ces clés de Registre se trouvent à l’emplacement suivant, où Root est HKEY_CURRENT_USER ou HKEY_LOCAL_MACHINE.

Root\Software\Microsoft\Bureau\Outlook\FormRegions\message, classe

Comme pour les autres entrées de Registre partagées par l'ensemble des compléments VSTO, Visual Studio crée les entrées de Registre de zones de formulaire sur l'ordinateur de développement au moment où vous générez votre projet. À l’aide de ClickOnce pour déployer votre complément VSTO, les entrées de Registre sont automatiquement créées sur l’ordinateur de l’utilisateur final. Lorsque vous utilisez Windows Installer pour déployer votre complément VSTO, vous devez configurer le projet InstallShield Limited Edition pour créer les entrées de Registre sur l’ordinateur de l’utilisateur final.

Pour plus d’informations sur les entrées de Registre de zone de formulaire, consultez Spécifier l’emplacement d’une zone de formulaire dans un formulaire personnalisé. Pour plus d’informations sur les zones de formulaire Outlook, consultez Créer des zones de formulaire Outlook.

Valeurs LoadBehavior

L’entrée LoadBehavior sous root\Software\Microsoft\Bureau\application name\Addins\add-in ID key contient une combinaison de valeurs au niveau du bit qui spécifient le comportement d’exécution du complément VSTO. Le bit d'ordre le plus bas (valeurs 0 et 1) indique si le complément VSTO est actuellement chargé ou non chargé. Les autres bits indiquent le moment où l'application tente de charger le complément VSTO.

En règle générale, l’entrée LoadBehavior est destinée à être définie sur 0, 3 ou 16 (en décimal) lorsque le complément VSTO est installé sur les ordinateurs de l’utilisateur final. Par défaut, Visual Studio affecte la valeur 3 à l'entrée LoadBehavior du complément VSTO quand vous le générez ou que vous le publiez.

Le tableau suivant répertorie toutes les valeurs possibles de l'entrée LoadBehavior . Certaines descriptions de ce tableau font référence au chargement manuel ou par programmation d'un complément VSTO. Pour charger un complément VSTO manuellement, cochez la case à côté du complément VSTO dans la boîte de dialogue Compléments COM de l'application. Pour charger un complément VSTO par programmation, affectez à la propriété Connect de l'objet COMAddIn qui représente ce complément la valeur true.

Valeur (au format décimal) État du complément VSTO Comportement de chargement du complément VSTO Description
0 Unloaded Ne chargez pas automatiquement L'application ne tente jamais de charger le complément VSTO automatiquement. L'utilisateur peut essayer de charger manuellement le complément VSTO. Sinon, le complément VSTO peut être chargé par programmation.

Si le complément VSTO est correctement chargé, la valeur LoadBehavior reste 0, mais l'état du complément VSTO dans la boîte de dialogue Compléments COM est mis à jour pour indiquer que ce complément est chargé.
1 Chargé Ne chargez pas automatiquement L'application ne tente jamais de charger le complément VSTO automatiquement. L'utilisateur peut essayer de charger manuellement le complément VSTO. Sinon, le complément VSTO peut être chargé par programmation.

Bien que la boîte de dialogue Compléments COM indique que le complément VSTO est chargé une fois l’application démarrée, le complément VSTO n’est pas chargé tant qu’il n’est pas chargé manuellement ou par programmation.

Si l'application charge correctement le complément VSTO, la valeur de LoadBehavior passe à 0, et reste à 0 après la fermeture de l'application.
2 Unloaded Charger au démarrage L’application n’essaie pas de charger automatiquement le complément VSTO. L'utilisateur peut essayer de charger manuellement le complément VSTO. Sinon, le complément VSTO peut être chargé par programmation.

Si l'application charge correctement le complément VSTO, la valeur de LoadBehavior passe à 3, et reste à 3 après la fermeture de l'application.
3 Chargé Charger au démarrage L'application tente de charger le complément VSTO au démarrage de l'application. Il s'agit de la valeur par défaut quand vous générez ou que vous publiez un complément VSTO dans Visual Studio.

Si l'application charge correctement le complément VSTO, la valeur de LoadBehavior reste égale à 3. Si une erreur se produit lors du chargement du complément VSTO, la valeur de LoadBehavior passe à 2, et reste à 2 après la fermeture de l'application.
8 Unloaded Charger à la demande L’application n’essaie pas de charger automatiquement le complément VSTO. L'utilisateur peut essayer de charger manuellement le complément VSTO. Sinon, le complément VSTO peut être chargé par programmation.

Si l'application charge correctement le complément VSTO, la valeur de LoadBehavior passe à 9.
9 Chargé Charger à la demande Le complément VSTO est chargé uniquement lorsque l’application l’exige. Par exemple, lorsqu’un utilisateur sélectionne un élément d’interface utilisateur qui utilise des fonctionnalités dans le complément VSTO (par exemple, un bouton personnalisé dans le ruban).

Si l'application charge correctement le complément VSTO, la valeur de LoadBehavior reste 9, mais l'état de ce complément dans la boîte de dialogue Compléments COM est mis à jour pour indiquer que le complément VSTO est actuellement chargé. Si une erreur se produit lors du chargement du complément VSTO, la valeur de LoadBehavior passe à 8.
16 Chargé Charger la première fois, puis charger à la demande Définissez cette valeur si vous voulez que votre complément VSTO soit chargé à la demande. L'application charge le complément VSTO quand l'utilisateur exécute l'application pour la première fois. La prochaine fois que l’utilisateur exécute l’application, l’application charge tous les éléments d’interface utilisateur définis par le complément VSTO. Toutefois, le complément VSTO n’est pas chargé tant que l’utilisateur n’a pas sélectionné un élément d’interface utilisateur associé au complément VSTO.

Quand l'application charge correctement le complément VSTO pour la première fois, la valeur de LoadBehavior reste 16 durant le chargement de ce complément. Après la fermeture de l'application, la valeur LoadBehavior passe à 9.

Contenu connexe