Office.SettingsChangedEventArgs interface

Paquet:

office

Fournit des informations sur les paramètres qui ont déclenché l’événement settingsChanged.

Pour ajouter un gestionnaire d’événements pour l’événement settingsChanged, utilisez la méthode addHandlerAsync de l’objet Office.Settings .

L’événement settingsChanged se déclenche uniquement lorsque le script de votre complément appelle la méthode Settings.saveAsync pour conserver la copie en mémoire des paramètres dans le fichier de document. L’événement settingsChanged ne se déclenche pas lors de l’appel de la méthode Settings.set ou Settings.remove.

L’événement settingsChanged a été conçu pour vous permettre de gérer les conflits potentiels lorsque deux utilisateurs ou plus tentent d’enregistrer des paramètres en même temps lorsque votre complément est utilisé dans un document partagé (co-créé).

Important : le code de votre complément peut inscrire un gestionnaire pour l’événement settingsChanged lorsque le complément s’exécute avec n’importe quel client Excel, mais l’événement se déclenche uniquement lorsque le complément est chargé avec une feuille de calcul ouverte dans Excel sur le Web et que plusieurs utilisateurs modifient la feuille de calcul (co-création). Par conséquent, l’événement settingsChanged est pris en charge uniquement dans Excel sur le Web dans les scénarios de co-création.

Propriétés

settings	Obtient un objet Office.Settings qui représente les paramètres qui ont déclenché l’événement settingsChanged.
type	Obtenez une valeur d’énumération Office.EventType qui identifie le type d’événement qui a été déclenché.

Détails de la propriété

settings

Obtient un objet Office.Settings qui représente les paramètres qui ont déclenché l’événement settingsChanged.

settings: Settings;

Valeur de propriété

Office.Settings

type

Obtenez une valeur d’énumération Office.EventType qui identifie le type d’événement qui a été déclenché.

type: EventType;

Valeur de propriété

Office.EventType