Office.Ribbon interface

  • Referência
Pacote:
office

Uma interface que contém todas as funcionalidades fornecidas para gerir o estado do friso do Office.

Comentários

Conjunto de requisitos: RibbonAPI 1.1

Métodos

requestCreateControls(tabDefinition)

Regista um separador contextual personalizado no Office e define os controlos do separador.
requestUpdate(input)

Envia um pedido ao Office para atualizar o friso.

Detalhes do método

requestCreateControls(tabDefinition)

Regista um separador contextual personalizado no Office e define os controlos do separador.

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

Parâmetros

tabDefinition

Object

Especifica as propriedades e os controlos subordinados do separador e as respetivas propriedades. Este parâmetro não é escrito de forma segura porque a forma é definida por um esquema JSON que pode ter um controlo de versão. Para criar o objeto de parâmetro, transmita uma cadeia JSON em conformidade com o esquema JSON do friso dinâmico do Office para JSON.parsee, em seguida, transmita o objeto devolvido para este método. Para obter o IntelliSense para o JSON no Visual Studio Code, veja Editar JSON com o Visual Studio Code – esquemas e definições JSON.

Retornos

Promise<void>

Comentários

Conjunto de requisitos: RibbonAPI 1.2

Este método apenas pede que o separador seja registado. O registo real é controlado pela aplicação do Office e poderá não estar concluído quando o objeto devolvido Promise for resolvido. Para obter mais informações e exemplos de código, veja Criar separadores contextuais personalizados.

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 um pedido ao Office para atualizar o friso.

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

Parâmetros

input
Office.RibbonUpdaterData

Representa as atualizações a serem feitas no friso. Tenha em atenção que apenas as alterações especificadas no parâmetro de entrada são efetuadas.

Retornos

Promise<void>

Comentários

Conjunto de requisitos: RibbonAPI 1.1

Tenha em atenção que esta API é apenas para pedir uma atualização. A atualização real da IU para o friso é controlada pela aplicação do Office e, por conseguinte, a temporização exata da atualização do friso (ou atualização) não pode ser determinada pela conclusão desta API.

Para obter exemplos de código, veja Ativar e Desativar Comandos de Suplemento eCriar separadores contextuais personalizados.

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