Office.Tab interface

パッケージ:

office

個々のタブと、そのタブに必要な状態を表します。 コード例については、「 アドイン コマンドの有効化と無効化」および 「 カスタム コンテキスト タブの作成」を参照してください。

注釈

要件セット: RibbonAPI 1.1

プロパティ

controls	メニュー項目、ボタンなど、タブ内の 1 つ以上のコントロールを指定します。
groups	タブ上の 1 つ以上のコントロール グループを指定します。
id	マニフェストで指定されたタブの識別子。
visible	タブをリボンに表示するかどうかを指定します。 コンテキスト タブでのみ使用されます。

プロパティの詳細

controls

メニュー項目、ボタンなど、タブ内の 1 つ以上のコントロールを指定します。

controls?: Control[];

プロパティ値

Office.Control[]

注釈

Tab オブジェクトが Office.Ribbon のrequestUpdate メソッドに渡される Office.RibbonUpdaterData オブジェクトの一部である場合、このプロパティは、有効な状態を変更するコントロールの ID を指定します。 ただし、タブに groups プロパティがある場合、このプロパティは無視され、有効な状態を変更するには、指定したグループの controls プロパティを使用する必要があります。

groups

タブ上の 1 つ以上のコントロール グループを指定します。

groups?: Group[];

プロパティ値

Office.Group[]

注釈

Tab オブジェクトが Office.Ribbon のrequestUpdateメソッドに渡される Office.RibbonUpdaterData オブジェクトの一部である場合、さまざまな Office.Group オブジェクトのcontrols プロパティは、有効な状態が変更されたコントロールを指定します。Tab オブジェクトのcontrols プロパティは無視されます。

要件セット: RibbonAPI 1.1

id

マニフェストで指定されたタブの識別子。

id: string;

プロパティ値

string

例

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

visible

タブをリボンに表示するかどうかを指定します。 コンテキスト タブでのみ使用されます。

visible?: boolean;

プロパティ値

boolean

注釈

要件セット: RibbonAPI 1.2

例

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