Office.Tab interface

Пакет:

office

Представляет отдельную вкладку и состояние, которое она должна иметь. Примеры кода см. в разделах Включение и отключение команд надстроек и Создание пользовательских контекстных вкладок.

Комментарии

Набор обязательных элементов: RibbonAPI 1.1

Свойства

controls	Задает один или несколько элементов управления на вкладке, таких как пункты меню, кнопки и т. д.
groups	Указывает одну или несколько групп элементов управления на вкладке.
id	Идентификатор вкладки, как указано в манифесте.
visible	Указывает, отображается ли вкладка на ленте. Используется только с контекстными вкладками.

Сведения о свойстве

controls

Задает один или несколько элементов управления на вкладке, таких как пункты меню, кнопки и т. д.

controls?: Control[];

Значение свойства

Office.Control[]

Комментарии

Tab Если объект является частью объекта Office.RibbonUpdaterData, переданного методу requestUpdateOffice.Ribbon, это свойство указывает идентификаторы элементов управления, состояние включения которых необходимо изменить. Однако если на вкладке есть groups свойство, это свойство игнорируется, а controls свойства указанных групп должны использоваться для изменения состояния включения.

groups

Указывает одну или несколько групп элементов управления на вкладке.

groups?: Group[];

Значение свойства

Office.Group[]

Комментарии

Tab Если объект является частью объекта Office.RibbonUpdaterData, переданного методу requestUpdateOffice.Ribbon, controls свойства различных объектов Office.Group указывают, какие элементы управления имеют controls измененное состояние. Свойство Tab объекта игнорируется.

Набор обязательных элементов: 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);
}