Office.Ribbon interface

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

Office リボンの状態を管理するために提供されるすべての機能を含むインターフェイス。

注釈

要件セット: RibbonAPI 1.1

メソッド

requestCreateControls(tabDefinition)

カスタム コンテキスト タブを Office に登録し、タブのコントロールを定義します。
requestUpdate(input)

リボンを更新する要求を Office に送信します。

メソッドの詳細

requestCreateControls(tabDefinition)

カスタム コンテキスト タブを Office に登録し、タブのコントロールを定義します。

requestCreateControls(tabDefinition: Object): Promise<void>;

パラメーター

tabDefinition

Object

タブのプロパティと子コントロールとそのプロパティを指定します。 このパラメーターは、バージョン管理可能な JSON スキーマによって定義されているため、厳密に型指定されません。 パラメーター オブジェクトを作成するには、Office の動的リボン JSON スキーマ に準拠する JSON 文字列を JSON.parseに渡し、返されたオブジェクトをこのメソッドに渡します。 Visual Studio Code で JSON の IntelliSense を取得するには、「 Visual Studio Code を使用した JSON の編集 - JSON スキーマと設定」を参照してください。

戻り値

Promise<void>

注釈

要件セット: RibbonAPI 1.2

このメソッドは、タブの登録のみを要求します。 実際の登録は Office アプリケーションによって制御され、返された Promise オブジェクトが解決されると完了しない可能性があります。 詳細とコード例については、「 カスタム コンテキスト タブの作成」を参照してください。

例

// Registers a custom contextual tab with Office.
Office.onReady(async () => {
    const contextualTabJSON = ` ... `; // Assign the JSON string.
    const contextualTab = JSON.parse(contextualTabJSON);
    await Office.ribbon.requestCreateControls(contextualTab);
});

requestUpdate(input)

リボンを更新する要求を Office に送信します。

requestUpdate(input: RibbonUpdaterData): Promise<void>;

パラメーター

input
Office.RibbonUpdaterData

リボンに対して行う更新を表します。 入力パラメーターで指定された変更のみが行われます。

戻り値

Promise<void>

注釈

要件セット: RibbonAPI 1.1

この API は、更新プログラムを要求することのみであることに注意してください。 リボンに対する実際の UI 更新は Office アプリケーションによって制御されるため、この API の完了によってリボンの更新 (または更新) の正確なタイミングを決定することはできません。

コード例については、「 アドイン コマンドの有効化と無効化」および 「 カスタム コンテキスト タブの作成」を参照してください。

例

// Office.Tab objects are properties of ribbon updater objects that are passed to the 
// Office.ribbon.requestUpdate method. The following shows how to set the visibility of 
// a custom contextual tab.

async function showDataTab() {
    await Office.ribbon.requestUpdate({
        tabs: [
            {
                id: "CtxTab1",
                visible: true
            }
        ]});
}

// The following does the same thing in TypeScript.

const showDataTab = async () => {
    const myContextualTab: Office.Tab = { id: "CtxTab1", visible: true };
    const ribbonUpdater: Office.RibbonUpdaterData = { tabs: [ myContextualTab ] };
    await Office.ribbon.requestUpdate(ribbonUpdater);
}