Office.Addin interface

パッケージ:

office

アドインのさまざまな側面を操作または構成するためのアドイン レベルの機能を表します。

注釈

要件セット: SharedRuntime 1.1

プロパティ

beforeDocumentCloseNotification

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

メソッド

getStartupBehavior()	アドインの現在のスタートアップ動作を取得します。
hide()	作業ウィンドウを非表示にします。
onVisibilityModeChanged(handler)	onVisibilityModeChanged イベントのハンドラーを追加します。
setStartupBehavior(behavior)	次回ドキュメントを開くときのアドインの起動動作を設定します。
showAsTaskpane()	アドインに関連付けられている作業ウィンドウを表示します。

プロパティの詳細

beforeDocumentCloseNotification

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

beforeDocumentCloseNotification: BeforeDocumentCloseNotification;

プロパティ値

Office.BeforeDocumentCloseNotification

注釈

要件セット: SharedRuntime 1.2

メソッドの詳細

getStartupBehavior()

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

getStartupBehavior(): Promise<Office.StartupBehavior>;

戻り値

Promise<Office.StartupBehavior>

注釈

要件セット: SharedRuntime 1.1

hide()

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

hide(): Promise<void>;

戻り値

Promise<void>

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

注釈

要件セット: SharedRuntime 1.1

onVisibilityModeChanged(handler)

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

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

パラメーター

handler

(message: Office.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)

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

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

パラメーター

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()

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

showAsTaskpane(): Promise<void>;

戻り値

Promise<void>

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

注釈

要件セット: SharedRuntime 1.1