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 でのみサポートされます。

注釈

例

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);
}

プロパティ

settings

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

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

プロパティの詳細

settings

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

settings: Settings;

プロパティ値

Office.Settings

type

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

type: EventType;

プロパティ値

Office.EventType