Office.Actions interface

Überprüft, ob derzeit eine Reihe von Tastenkombinationen für den Benutzer verwendet wird, wie von einem anderen Add-In oder von der Office-Anwendung definiert. Weitere Informationen finden Sie unter Hinzufügen benutzerdefinierter Tastenkombinationen zu Ihren Office-Add-Ins.

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

Parameter

Gibt zurück

Eine Zusage, die in ein Array von Objekten aufgelöst wird. Jedes Objekt besteht aus einer Tastenkombinationskombination und einem booleschen Wert. Der Wert wird verwendettrue, wenn die Tastenkombination mit einer Verknüpfung eines anderen Add-Ins oder mit einer Verknüpfung der Office-Anwendung in Konflikt steht. Andernfalls wird angezeigt. false Beispiel: [{shortcut:"Ctrl+1", inUse:true},{shortcut:"Ctrl+2", inUse:false}].

Hinweise

Anforderungssätze:

• KeyboardShortcuts 1.1

• SharedRuntime 1.1

Beispiele

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

Ordnet die ID oder den Namen einer Aktion einer Funktion zu.

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

Parameter

Gibt zurück

Beispiele

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

Ruft die vorhandenen Tastenkombinationen für das Add-In ab. Das Set enthält immer (1) die im Manifest des Add-Ins für Tastenkombinationen definierten Tastenkombinationen und (2) die benutzerdefinierten Tastenkombinationen des aktuellen Benutzers, sofern vorhanden. Die Tastenkombination kann sein null , wenn sie mit der Verknüpfung eines anderen Add-Ins oder mit der Office-Anwendung in Konflikt steht. Genauer gesagt, wenn der Benutzer bei der Aufforderung zur Auswahl der zu verwendenden Tastenkombination nicht die Aktion des aktuellen Add-Ins ausgewählt hat null . Weitere Informationen zu Konflikten mit Tastenkombinationen finden Sie unter Vermeiden von Tastenkombinationen, die von anderen Add-Ins verwendet werden.

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

Gibt zurück

Eine Zusage, die in ein Objekt von Tastenkombinationen aufgelöst wird, wobei keys die IDs der Aktionen (wie in einem Manifest definiert) und Werte die Tastenkombinationen sind. Beispiel: {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}.

Hinweise

Anforderungssätze:

• KeyboardShortcuts 1.1

• SharedRuntime 1.1

Beispiele

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

Ersetzt vorhandene Add-In-Tastenkombinationen durch benutzerdefinierte Tastenkombinationen für den Benutzer.

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

Parameter

Gibt zurück

Eine Zusage, die aufgelöst wird, wenn jede zugewiesene shortcuts benutzerdefinierte Tastenkombination registriert wurde. Auch wenn ein Konflikt mit vorhandenen Tastenkombinationen besteht, wird die angepasste Tastenkombination registriert. Andernfalls wird die Zusage mit einem Fehlercode und einer Fehlermeldung abgelehnt. Ein OfficeExtension.ErrorCodes.invalidArgument Fehlercode wird zurückgegeben, wenn keine Aktions-ID vorhanden shortcuts ist oder wenn die Tastenkombination ungültig ist.

Hinweise

Anforderungssätze:

• KeyboardShortcuts 1.1

• SharedRuntime 1.1

Beispiele

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