Office.SettingsChangedEventArgs interface
Bietet Informationen zu den Einstellungen, durch die das Ereignis settingsChanged ausgelöst wurde.
Verwenden Sie zum Hinzufügen eines Ereignishandlers für das settingsChanged-Ereignis die addHandlerAsync-Methode des Office.Settings-Objekts .
Das Ereignis settingsChanged wird nur ausgelöst, wenn das Skript Ihres Add-Ins die Settings.saveAsync-Methode aufruft, um die In-Memory-Kopie der Einstellungen in der Dokumentdatei zu speichern. Das settingsChanged-Ereignis wird nicht ausgelöst, wenn die Methoden Settings.set oder Settings.remove aufgerufen werden.
Das settingsChanged-Ereignis wurde entwickelt, damit Sie potenzielle Konflikte behandeln können, wenn zwei oder mehr Benutzer gleichzeitig versuchen, Einstellungen zu speichern, wenn Ihr Add-In in einem freigegebenen Dokument (gemeinsam erstellt) verwendet wird.
Wichtig: Der Code Ihres Add-Ins kann einen Handler für das Ereignis "settingsChanged" registrieren, wenn das Add-In mit einem beliebigen Excel-Client ausgeführt wird. Das Ereignis wird jedoch nur ausgelöst, wenn dem Add-In eine Kalkulationstabelle geladen wird, die in Excel im Web geöffnet wird, und mehr als ein Benutzer die Kalkulationstabelle bearbeitet (gemeinsam dokumenter). Daher wird das settingsChanged-Ereignis effektiv nur in Excel im Web in Szenarien für die gemeinsame Dokumenterstellung unterstützt.
Hinweise
Beispiele
function addSelectionChangedEventHandler() {
Office.context.document.settings.addHandlerAsync(Office.EventType.SettingsChanged, MyHandler);
}
function MyHandler(eventArgs: Office.SettingsChangedEventArgs) {
console.log('Event raised: ' + eventArgs.type);
doSomethingWithSettings(eventArgs.settings);
}
Eigenschaften
| settings | Ruft ein Office.Settings-Objekt ab, das die Einstellungen darstellt, durch die das settingsChanged-Ereignis ausgelöst wurde. |
| type | Rufen Sie einen Office.EventType-Enumerationswert ab, der den Typ des ausgelösten Ereignisses angibt. |
Details zur Eigenschaft
settings
Ruft ein Office.Settings-Objekt ab, das die Einstellungen darstellt, durch die das settingsChanged-Ereignis ausgelöst wurde.
settings: Settings;Eigenschaftswert
type
Rufen Sie einen Office.EventType-Enumerationswert ab, der den Typ des ausgelösten Ereignisses angibt.
type: EventType;