Activer votre complément Outlook sans le volet de lecture activé ou un message sélectionné

  • Article

Avec une configuration de manifeste simple, vous pouvez créer des compléments Outlook pour la surface de lecture des messages qui activent un volet Office sans que le volet de lecture soit activé ou qu’un message soit sélectionné d’abord dans la boîte aux lettres. Cette fonctionnalité est appelée « contexte sans élément ». Suivez la procédure pas à pas pour en savoir plus et déverrouiller des fonctionnalités supplémentaires pour votre complément. Par exemple, vous pouvez autoriser vos utilisateurs à accéder au contenu de différentes sources de données, telles que OneDrive ou un système de gestion de la relation client (CRM), directement à partir de leur client Outlook.

Remarque

La prise en charge de cette fonctionnalité a été introduite dans l’ensemble de conditions requises 1.13. Voir les clients et les plateformes qui prennent en charge cet ensemble de conditions requises.

Bien que Outlook sur le web et la nouvelle version d’Outlook sur Windows (préversion) prennent en charge l’ensemble de conditions requises 1.13, un complément ne s’active pas si le volet de lecture est masqué ou si un message n’est pas sélectionné. Pour plus d’informations, consultez Prise en charge des fonctionnalités dans Outlook sur le web et nouvelle version d’Outlook sur Windows (préversion).

Configuration de votre environnement

Suivez le guide de démarrage rapide Outlook dans lequel vous créez un complément Outlook avec le générateur Yeoman pour les compléments Office.

Pour activer cette fonctionnalité dans un projet de complément préexistant, consultez Configurer le manifeste.

Configurer le manifeste

Les étapes de configuration du manifeste varient en fonction du type de manifeste utilisé par votre complément.

  1. Dans votre éditeur de code préféré, ouvrez le projet de démarrage rapide Outlook que vous avez créé.

  2. Ouvrez le fichier manifest.json situé à la racine du projet.

  3. Dans le premier objet du tableau « extensions.runtimes », procédez comme suit :

    1. Remplacez « requirements.capabilities.minVersion » par « 1.13 ».
    2. Ajoutez une propriété « supportsNoItemContext » à l’objet dans le tableau « actions » et définissez sa valeur sur true.
    3. Ajoutez une propriété « multiselect » au même objet et définissez-la sur true.
    4. Remplacez la propriété « épinglé » dans le même objet par true.

    Lorsque vous avez terminé, l’opération doit ressembler à ce qui suit.

    "runtimes": [
    {
        "requirements": {
            "capabilities": [
                {
                    "name": "Mailbox",
                    "minVersion": "1.13"
                }
            ]
        },
        "id": "TaskPaneRuntime",
        "type": "general",
        "code": {
            "page": "https://localhost:3000/taskpane.html"
        },
        "lifetime": "short",
        "actions": [
            {
                "id": "TaskPaneRuntimeShow",
                "type": "openPage",
                "view": "dashboard",
                "pinnable": true,
                "supportsNoItemContext": true,
                "multiselect": true
            }
        ]
    }
]

  4. Supprimez le deuxième objet du tableau « extensions.runtimes », dont « id » est « CommandsRuntime ».

  5. Le tableau « extensions.ribbons.tabs.groups.controls » comporte deux objets. Supprimez le deuxième, dont « id » est « ActionButton ».

Configurer le volet Office

  1. Dans votre projet, accédez au dossier du volet des tâches , puis ouvrez taskpane.html.

  2. Remplacez l’élément body> entier< par le balisage suivant.

    <body class="ms-font-m ms-welcome ms-Fabric">
    <header class="ms-welcome__header ms-bgColor-neutralLighter">
        <img width="90" height="90" src="../../assets/logo-filled.png" alt="logo" title="Add-in logo" />
        <h1 class="ms-font-su">Activate your add-in without enabling the Reading Pane or selecting a message</h1>
    </header>
    <section id="sideload-msg" class="ms-welcome__main">
        <h2 class="ms-font-xl">Please <a target="_blank" href="https://learn.microsoft.com/office/dev/add-ins/testing/test-debug-office-add-ins#sideload-an-office-add-in-for-testing">sideload</a> your add-in to see app body.</h2>
    </section>
    <main id="app-body" class="ms-welcome__main" style="display: none;">
        <ul class="ms-List ms-welcome__features">
            <li class="ms-ListItem">
                <i class="ms-Icon ms-Icon--CheckList ms-font-xl"></i>
                <span class="ms-font-m">Item multi-select is automatically enabled when the <b>SupportsNoItemContext</b> manifest element is set to <code>true</code>. You can test this by selecting multiple messages in Outlook, then choosing <b>Show Taskpane</b> from the ribbon.</span>
            </li>
            <li class="ms-ListItem">
                <i class="ms-Icon ms-Icon--Pin ms-font-xl"></i>
                <span class="ms-font-m">Support to pin the task pane is also automatically enabled. You can test this by selecting the <b>pin</b> icon from the top right corner of the task pane.</span>
            </li>
            <li class="ms-ListItem">
                <i class="ms-Icon ms-Icon--DockRight ms-font-xl"></i>
                <span class="ms-font-m">This feature can only be implemented with a task pane.</span>
            </li>
            <li class="ms-ListItem">
                <i class="ms-Icon ms-Icon--Design ms-font-xl"></i>
                <span class="ms-font-m">Implement your scenario using this feature today! For example, enable your users to access content from different data sources, such as OneDrive or your customer relationship management (CRM) system, without first selecting a message.</span>
            </li>
        </ul>
    </main>
</body>

  3. Enregistrez vos modifications.

Mettre à jour le fichier JavaScript du volet Office

  1. À partir du dossier du volet des tâches , ouvrez taskpane.js.

  2. Accédez à la Office.onReady fonction et remplacez son contenu par le code suivant.

    if (info.host === Office.HostType.Outlook) {
    document.getElementById("sideload-msg").style.display = "none";
    document.getElementById("app-body").style.display = "flex";
}

  3. Enregistrez vos modifications.

Essayez

  1. À partir d’un terminal, exécutez le code suivant dans le répertoire racine de votre projet. Cela démarre le serveur web local et charge une version test de votre complément.

    npm start

    Conseil

    Si votre complément ne charge pas automatiquement la version test, suivez les instructions fournies dans Charger une version test des compléments Outlook pour le charger manuellement dans Outlook.

  2. Accédez à votre boîte de réception et effectuez l’une des opérations suivantes :

  3. Sélectionnez Afficher le volet des tâches dans le ruban.

  4. Explorez et testez les suggestions répertoriées dans le volet Office.

Prise en charge des fonctionnalités du volet Office à sélection multiple et pouvant être épinglées

L’activation de la prise en charge de l’absence de contexte d’élément dans le manifeste active automatiquement la prise en charge des fonctionnalités du volet Office à sélection multiple et épinglées d’élément, même si ces fonctionnalités ne sont pas explicitement configurées dans le manifeste.

Prise en charge des fonctionnalités dans Outlook sur le web et outlook sur Windows (préversion)

Dans Outlook sur le web et outlook sur Windows (préversion), les compléments qui n’implémentent aucun contexte d’élément ne s’activent pas lorsque le volet de lecture est masqué ou lorsqu’un message n’est pas sélectionné. Cela est dû au fait que les commandes de complément dans Outlook sur le web n’apparaissent pas sur le ruban. Pour activer un complément à partir de l’aire de lecture du message, vous devez d’abord sélectionner un message, puis sélectionner la commande de complément dans la barre d’action du message.

Étant donné que l’activation d’aucun contexte d’élément active automatiquement la fonctionnalité de sélection multiple d’élément, vous pouvez activer votre complément dans Outlook sur le web et outlook sur Windows sur plusieurs éléments de messagerie.

Voir aussi