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, которую можно использовать для изменения версий. Чтобы создать объект параметра, передайте строку JSON, соответствующую схеме JSON.parseJSON динамической ленты Office, в , а затем передайте возвращенный объект в этот метод. Сведения о том, как получить IntelliSense для JSON в Visual Studio Code, см. в статье Изменение JSON с помощью Visual Studio Code — схемы и параметры 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 предназначен только для запроса обновления. Фактическое обновление пользовательского интерфейса ленты контролируется приложением 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);
}