Partager via

Office.Actions interface

  • Référence
Paquet:
office

Gère les actions et les raccourcis clavier.

Méthodes

areShortcutsInUse(shortcuts)

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.
associate(actionId, actionFunction)

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

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 s’ils existent. Le raccourci peut être 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 si, quand il est invité à choisir le raccourci à utiliser, l’utilisateur n’a pas choisi l’action du complément actuel. Pour plus d’informations sur les conflits avec les raccourcis, consultez Éviter les combinaisons de touches utilisées par d’autres compléments.
replaceShortcuts(shortcuts)

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

Détails de la méthode

areShortcutsInUse(shortcuts)

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

shortcuts

string[]

Tableau de combinaisons de raccourcis. Par exemple, ["Ctrl+1", "Ctrl+2"].

Retours

Promise<Array<{shortcut: string, inUse: boolean}>>

Promesse qui se résout en tableau d’objets. Chaque objet se compose 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 :

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}`);
});

associate(actionId, actionFunction)

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

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

Paramètres

actionId

string

ID d’une action définie dans le manifeste.

actionFunction

(arg?: any) => void

Fonction exécutée lorsque l’action est appelée.

Retours

void

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);
        });
}

getShortcuts()

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 s’ils existent. Le raccourci peut être 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 si, quand il est invité à choisir le raccourci à utiliser, l’utilisateur n’a pas choisi l’action du complément actuel. Pour plus d’informations sur les conflits avec les raccourcis, consultez Éviter les combinaisons de touches utilisées par d’autres compléments.

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

Retours

Promise<{[actionId: string]: string|null}>

Promesse qui se résout en un objet de raccourcis, les touches é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 :

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}`);
        }
});

replaceShortcuts(shortcuts)

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

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

Paramètres

shortcuts

{[actionId: string]: string}

Objet de raccourcis personnalisés avec les touches étant les ID des actions et les valeurs étant les combinaisons de raccourcis. Par exemple, {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}. Pour savoir comment spécifier un ID d’action valide et une combinaison de touches, voir Ajouter des raccourcis clavier personnalisés à vos compléments Office. (Notez qu’une combinaison de touches peut être null, auquel cas, l’action conserve la combinaison de touches spécifiée dans le fichier JSON.)

Retours

Promise<void>

Promesse qui se résout lorsque chaque affectation de raccourci personnalisé dans shortcuts a été inscrite. Même en cas de conflit avec les raccourcis existants, le raccourci personnalisé est inscrit. Sinon, la promesse est rejetée avec le code d’erreur et le message d’erreur. Un code d’erreur « InvalidOperation » est retourné si aucun ID d’action dans shortcuts n’existe, ou si la combinaison de raccourcis n’est pas valide.

Remarques

Ensembles de conditions requises :

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.");
        }
});