Office.SettingsChangedEventArgs interface

  • リファレンス
パッケージ:
office

settingsChanged イベントが発生した設定についての情報を提供します。

settingsChanged イベントのイベント ハンドラーを追加するには、 Office.Settings オブジェクトの addHandlerAsync メソッドを使用します。

settingsChanged イベントは、アドインのスクリプトが Settings.saveAsync メソッドを呼び出して、設定のメモリ内コピーをドキュメント ファイルに保持する場合にのみ発生します。 settingsChanged イベントは、Settings.set または Settings.remove メソッドが呼び出された場合にはトリガーされません。

settingsChanged イベントは、2 人以上のユーザーが共有 (共同編集) ドキュメントでアドインを使用するときに同時に設定を保存しようとしたときに、競合の可能性を処理できるように設計されています。

重要: アドインのコードは、アドインが Excel クライアントで実行されているときに settingsChanged イベントのハンドラーを登録できますが、イベントは、アドインがExcel on the webで開かれたスプレッドシートで読み込まれ、複数のユーザーがスプレッドシートを編集 (共同編集) している場合にのみ発生します。 したがって、実質的に settingsChanged イベントは、共同編集シナリオのExcel on the webでのみサポートされます。

プロパティ

settings

settingsChanged イベントを発生させた設定を表す Office.Settings オブジェクトを取得します。
type

発生したイベントの種類を識別する Office.EventType 列挙値を取得します。

プロパティの詳細

settings

settingsChanged イベントを発生させた設定を表す Office.Settings オブジェクトを取得します。

settings: Settings;

プロパティ値

Office.Settings

type

発生したイベントの種類を識別する Office.EventType 列挙値を取得します。

type: EventType;

プロパティ値

Office.EventType