Office.SettingsChangedEventArgs interface
Bietet Informationen zu den Einstellungen, durch die das Ereignis settingsChanged ausgelöst wurde.
Um einen Ereignishandler für das settingsChanged-Ereignis hinzuzufügen, verwenden Sie die addHandlerAsync-Methode des Office.Settings-Objekts .
Das SettingsChanged-Ereignis wird nur ausgelöst, wenn das Skript Ihres Add-Ins die Settings.saveAsync-Methode aufruft, um die Speicherkopie der Einstellungen in der Dokumentdatei beizubehalten. 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 (mitverfassten) Dokument verwendet wird.
Wichtig: Der Code Ihres Add-Ins kann einen Handler für das settingsChanged-Ereignis registrieren, wenn das Add-In mit einem beliebigen Excel-Client ausgeführt wird. Das Ereignis wird jedoch nur ausgelöst, wenn das Add-In mit einer Kalkulationstabelle geladen wird, die in Excel im Web geöffnet wird und mehrere Benutzer die Tabelle bearbeiten (gemeinsame Dokumenterstellung). Daher wird das settingsChanged-Ereignis nur in Excel im Web in Szenarien mit der gemeinsamen Dokumenterstellung unterstützt.
Hinweise
Beispiele
function addSelectionChangedEventHandler() {
Office.context.document.settings.addHandlerAsync(Office.EventType.SettingsChanged, MyHandler);
}
function MyHandler(eventArgs: Office.SettingsChangedEventArgs) {
write('Event raised: ' + eventArgs.type);
doSomethingWithSettings(eventArgs.settings);
}
// Function that writes to a div with id='message' on the page.
function write(message) {
document.getElementById('message').innerText += message;
}
Eigenschaften
| settings | Ruft ein Office.Settings-Objekt ab, das die Einstellungen darstellt, die das settingsChanged-Ereignis ausgelöst haben. |
| type | Rufen Sie einen Office.EventType-Enumerationswert ab, der die Art des ausgelösten Ereignisses angibt. |
Details zur Eigenschaft
settings
Ruft ein Office.Settings-Objekt ab, das die Einstellungen darstellt, die das settingsChanged-Ereignis ausgelöst haben.
settings: Settings;Eigenschaftswert
type
Rufen Sie einen Office.EventType-Enumerationswert ab, der die Art des ausgelösten Ereignisses angibt.
type: EventType;