Office.Ribbon interface

Pacote:
office

Uma interface que contém todas as funcionalidades fornecidas para gerenciar o estado da faixa de opções do Office.

Comentários

Conjunto de requisitos: RibbonApi 1.1

Métodos

requestCreateControls(tabDefinition)

Registra uma guia contextual personalizada no Office e define os controles da guia.
requestUpdate(input)

Envia uma solicitação ao Office para atualizar a faixa de opções.

Detalhes do método

requestCreateControls(tabDefinition)

Registra uma guia contextual personalizada no Office e define os controles da guia.

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

Parâmetros

tabDefinition

Object

Especifica as propriedades da guia e os controles filho e suas propriedades. Esse parâmetro não é fortemente tipado porque sua forma é definida por um esquema JSON que pode ser versionado. Para criar o objeto de parâmetro, passe uma cadeia de caracteres JSON que esteja em conformidade com o esquema JSON da faixa de opções dinâmica do Office para JSON.parsee passe o objeto retornado para esse método. Para obter o IntelliSense para o JSON no Visual Studio Code, consulte Editando JSON com o Visual Studio Code - Esquemas e configurações JSON.

Retornos

Promise<void>

Comentários

Conjunto de requisitos: RibbonApi 1.2

Esse método solicita apenas que a guia seja registrada. O registro real é controlado pelo aplicativo do Office e pode não ser concluído quando o objeto retornado Promise for resolvido. Para obter mais informações e exemplos de código, consulte Criar guias contextuais personalizadas.

Exemplos

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

Envia uma solicitação ao Office para atualizar a faixa de opções.

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

Parâmetros

input
Office.RibbonUpdaterData

Representa as atualizações a serem feitas na faixa de opções. Observe que somente as alterações especificadas no parâmetro de entrada são feitas.

Retornos

Promise<void>

Comentários

Conjunto de requisitos: RibbonApi 1.1

Observe que esta API é apenas para solicitar uma atualização. A atualização real da interface do usuário para a faixa de opções é controlada pelo aplicativo do Office e, portanto, o momento exato da atualização (ou atualização) da faixa de opções não pode ser determinado pela conclusão dessa API.

Para obter exemplos de código, consulte Alterar a disponibilidade de comandos de suplemento e Criar guias contextuais personalizadas.

Exemplos

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