Compartilhar via

Office.Tab interface

  • Referência
Pacote:
office

Representa um separador individual e o estado que deveria ter. Para obter exemplos de código, veja Ativar e Desativar Comandos de Suplemento eCriar separadores contextuais personalizados.

Comentários

Conjunto de requisitos: RibbonAPI 1.1

Exemplos

// Create an Office.Tab object (a contextual tab), set its visibility
// and add it to the ribbon.
async function showDataTab() {
    // Create the Office.Tab object.
    const myContextualTab = { id: "CtxTab1", visible: true };
    const ribbonUpdater = { tabs: [ myContextualTab ] };
    await Office.ribbon.requestUpdate(ribbonUpdater);
}

Propriedades

controls

Especifica um ou mais dos controlos no separador, como itens de menu, botões, etc.
groups

Especifica um ou mais grupos de controlo no separador.
id

Identificador do separador conforme especificado no manifesto.
visible

Especifica se o separador está visível no friso. Utilizado apenas com separadores contextuais.

Detalhes da propriedade

controls

Especifica um ou mais dos controlos no separador, como itens de menu, botões, etc.

controls?: Control[];

Valor da propriedade

Office.Control[]

Comentários

Quando o Tab objeto faz parte de um objeto Office.RibbonUpdaterData transmitido ao requestUpdate método do Office.Ribbon, esta propriedade especifica os IDs dos controlos cujo estado ativado deve ser alterado. No entanto, se existir uma groups propriedade no separador, esta propriedade é ignorada e as controls propriedades dos grupos especificados têm de ser utilizadas para alterar o estado ativado.

groups

Especifica um ou mais grupos de controlo no separador.

groups?: Group[];

Valor da propriedade

Office.Group[]

Comentários

Quando o Tab objeto faz parte de um objeto Office.RibbonUpdaterData transmitido ao requestUpdate método do Office.Ribbon, as controls propriedades dos vários objetos Office.Group especificam quais os controlos que têm o respetivo estado ativado alterado; a controls propriedade do Tab objeto é ignorada.

Conjunto de requisitos: RibbonAPI 1.1

id

Identificador do separador conforme especificado no manifesto.

id: string;

Valor da propriedade

string

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

Especifica se o separador está visível no friso. Utilizado apenas com separadores contextuais.

visible?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de requisitos: RibbonAPI 1.2

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