Office.Actions interface

  • Referenz
Paket:
office

Verwaltet Aktionen und Tastenkombinationen.

Eigenschaften

associate

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

Methoden

areShortcutsInUse(shortcuts)

Überprüft, ob derzeit eine Reihe von Tastenkombinationen für den Benutzer verwendet werden, wie von einem anderen Add-In oder von der Office-Anwendung definiert.
getShortcuts()

Ruft die vorhandenen Tastenkombinationen für das Add-In ab. Der Satz enthält immer (1) die Tastenkombinationen, die im erweiterten Manifest des Add-Ins für Tastenkombinationen definiert sind, und (2) die benutzerdefinierten Tastenkombinationen des aktuellen Benutzers, sofern vorhanden. Die Verknüpfung kann sein null , wenn sie mit der Verknüpfung eines anderen Add-Ins oder mit der Office-Anwendung in Konflikt tritt. Dies ist null insbesondere der Fall, wenn der Benutzer bei der Aufforderung zur Auswahl der zu verwendenden Verknüpfung nicht die Aktion des aktuellen Add-Ins auswählt. Weitere Informationen zu Konflikten mit Tastenkombinationen finden Sie unter Vermeiden von Tastenkombinationen, die von anderen Add-Ins verwendet werden.
replaceShortcuts(shortcuts)

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

Details zur Eigenschaft

associate

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

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

Eigenschaftswert

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

Details zur Methode

areShortcutsInUse(shortcuts)

Überprüft, ob derzeit eine Reihe von Tastenkombinationen für den Benutzer verwendet werden, wie von einem anderen Add-In oder von der Office-Anwendung definiert.

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

Parameter

shortcuts

string[]

Ein Array von Tastenkombinationen. Beispiel: ["Ctrl+1", "Ctrl+2"].

Gibt zurück

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

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

Hinweise

Anforderungssätze:

getShortcuts()

Ruft die vorhandenen Tastenkombinationen für das Add-In ab. Der Satz enthält immer (1) die Tastenkombinationen, die im erweiterten Manifest des Add-Ins für Tastenkombinationen definiert sind, und (2) die benutzerdefinierten Tastenkombinationen des aktuellen Benutzers, sofern vorhanden. Die Verknüpfung kann sein null , wenn sie mit der Verknüpfung eines anderen Add-Ins oder mit der Office-Anwendung in Konflikt tritt. Dies ist null insbesondere der Fall, wenn der Benutzer bei der Aufforderung zur Auswahl der zu verwendenden Verknüpfung nicht die Aktion des aktuellen Add-Ins auswählt. 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

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

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

Hinweise

Anforderungssätze:

replaceShortcuts(shortcuts)

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

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

Parameter

shortcuts

{[actionId: string]: string}

Ein Objekt von benutzerdefinierten Tastenkombinationen, bei denen die Tasten die IDs der Aktionen sind (wie in einem erweiterten Manifest definiert) und Werte die Tastenkombinationen sind. Beispiel: {"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}. Informationen zum Angeben einer gültigen Aktions-ID und einer Tastenkombination finden Sie unter Hinzufügen benutzerdefinierter Tastenkombinationen zu Ihren Office-Add-Ins. (Beachten Sie, dass eine Tastenkombination sein nullkann. In diesem Fall behält die Aktion die in der JSON-Datei angegebene Tastenkombination bei.)

Gibt zurück

Promise<void>

Eine Zusage, die aufgelöst wird, wenn jede benutzerdefinierte Tastenkombinationszuweisung in shortcuts registriert wurde. Auch wenn ein Konflikt mit vorhandenen Verknüpfungen besteht, wird die angepasste Verknüpfung registriert. Andernfalls wird die Zusage mit Fehlercode und Fehlermeldung abgelehnt. Ein Fehlercode "InvalidOperation" wird zurückgegeben, wenn keine Aktions-ID in shortcuts vorhanden ist oder wenn die Tastenkombination ungültig ist.

Hinweise

Anforderungssätze: