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