Office.Actions interface

Vérifie si un ensemble de combinaisons de raccourcis est actuellement utilisé pour l’utilisateur, tel que défini par un autre complément ou par l’application Office. Pour plus d’informations, voir Ajouter des raccourcis clavier personnalisés à vos compléments Office.

areShortcutsInUse(shortcuts: string[]): Promise<Array<{shortcut: string, inUse: boolean}>>;

Paramètres

Retours

Une promesse qui se résout en un tableau d’objets. Chaque objet est constitué d’une combinaison de raccourcis et d’une valeur booléenne. La valeur est si la combinaison de raccourcis est true en conflit avec un raccourci d’un autre complément ou avec un raccourci de l’application Office ; sinon, false. Par exemple, [{shortcut:"Ctrl+1", inUse:true},{shortcut:"Ctrl+2", inUse:false}].

Remarques

Ensembles de conditions requises :

• KeyboardShortcuts 1.1

• SharedRuntime 1.1

Exemples

// Checks if a specific keyboard shortcut is in use.
const shortcuts = ["Ctrl+Shift+1", "Ctrl+Shift+2"];
Office.actions.areShortcutsInUse(shortcuts)
    .then((shortcutsInUse) => {
        const availableShortcuts = shortcutsInUse.filter((shortcut) => { return !shortcut.inUse; });
        console.log(`Available keyboard shortcuts: ${availableShortcuts}`);
        const usedShortcuts = shortcutsInUse.filter((shortcut) => { return shortcut.inUse; });
        console.log(`Shortcuts in use: ${usedShortcuts}`);
});

Associe l’ID ou le nom d’une action à une fonction.

associate(actionId: string, actionFunction: (arg?: any) => void): void;

Paramètres

Retours

Exemples

// Maps the action ID to the showTaskPane function.
Office.actions.associate("ShowTaskpane", showTaskPane);

// Displays the add-in's task pane.
function showTaskPane() {
    return Office.addin.showAsTaskpane()
        .then(() => { console.log("Task pane is visible."); })
        .catch((error) => {
            console.log(error.code);
        });
}

Obtient les raccourcis existants pour le complément. L’ensemble inclut toujours (1) les raccourcis définis dans le manifeste du complément pour les raccourcis clavier et (2) les raccourcis personnalisés de l’utilisateur actuel, le cas échéant. Le raccourci peut indiquer null s’il est en conflit avec le raccourci d’un autre complément ou avec l’application Office. Plus précisément, ce serait null le cas si, lorsqu’il est invité à choisir le raccourci à utiliser, l’utilisateur ne choisit pas l’action du complément actuel. Pour plus d’informations sur les conflits avec les raccourcis, voir Éviter les combinaisons de touches utilisées par d’autres compléments.

getShortcuts(): Promise<{[actionId: string]: string|null}>;

Retours

Promesse résolue en un objet de raccourcis, les clés étant les ID des actions (telles que définies dans un manifeste) et les valeurs étant les combinaisons de raccourcis. Par exemple, {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}.

Remarques

Ensembles de conditions requises :

• KeyboardShortcuts 1.1

• SharedRuntime 1.1

Exemples

// Gets the list of keyboard shortcuts for an add-in.
Office.actions.getShortcuts()
    .then((shortcuts) => {
        for (const action in shortcuts) {
            let shortcut = shortcuts[action];
            console.log(`${action}: ${shortcut}`);
        }
});

Remplace les raccourcis de complément existants par des raccourcis personnalisés pour l’utilisateur.

replaceShortcuts(shortcuts: {[actionId: string]: string}): Promise<void>;

Paramètres

Retours

Promesse qui se résout lorsque chaque affectation shortcuts de raccourci personnalisé a été enregistrée. Même s’il existe un conflit avec les raccourcis existants, le raccourci personnalisé est enregistré. Sinon, la promesse sera rejetée avec un code et un message d’erreur. Un OfficeExtension.ErrorCodes.invalidArgument code d’erreur est renvoyé si un ID d’action n’existe shortcuts pas ou si la combinaison de raccourcis n’est pas valide.

Remarques

Ensembles de conditions requises :

• KeyboardShortcuts 1.1

• SharedRuntime 1.1

Exemples

// Replaces the keyboard shortcuts of an add-in.
const customShortcuts = {
    ShowTaskpane:"Ctrl+Shift+1",
    HideTaskpane:"Ctrl+Shift+2"
};
Office.actions.replaceShortcuts(customShortcuts)
    .then(() => { console.log("Keyboard shortcuts successfully registered."); })
    .catch((error) => {
        if (error.code === "InvalidOperation") {
            console.log("ActionId does not exist or shortcut combination is invalid.");
        }
});