Office.Addin interface

ユーザーがドキュメントを閉じようとしたときに表示されるモーダル通知ダイアログを表します。 ユーザーが応答するまで、ドキュメントは閉じられません。 この API は Excel でのみサポートされています。

beforeDocumentCloseNotification: BeforeDocumentCloseNotification;

プロパティ値

注釈

要件セット: SharedRuntime 1.2

アドインの現在のスタートアップ動作を取得します。

getStartupBehavior(): Promise<Office.StartupBehavior>;

戻り値

注釈

要件セット: SharedRuntime 1.1

作業ウィンドウを非表示にします。

hide(): Promise<void>;

戻り値

UI が非表示のときに解決される promise。

注釈

要件セット: SharedRuntime 1.1

onVisibilityModeChanged イベントのハンドラーを追加します。

onVisibilityModeChanged(
            handler: (message: VisibilityModeChangedMessage) => void,
        ): Promise<() => Promise<void>>;

パラメーター

戻り値

ハンドラーが追加されたときに関数に解決される promise。 これを呼び出すと、ハンドラーが削除されます。

注釈

要件セット: SharedRuntime 1.1

例

Office.onReady(() => {
    Office.addin.onVisibilityModeChanged((args) => {
        if (args.visibilityMode === Office.VisibilityMode.taskpane) {
            // Do something when the task pane is visible.
        }
    });

    // Other startup tasks.
});

次回ドキュメントを開くときのアドインの起動動作を設定します。

setStartupBehavior(behavior: Office.StartupBehavior): Promise<void>;

パラメーター

戻り値

注釈

要件セット: SharedRuntime 1.1

例

// Configure your add-in to load and start running when the document is opened.
Office.addin.setStartupBehavior(Office.StartupBehavior.load);

アドインに関連付けられている作業ウィンドウを表示します。

showAsTaskpane(): Promise<void>;

戻り値

UI が表示されたときに解決される promise。

注釈

要件セット: SharedRuntime 1.1