Office.Tab interface

Pacote:
office

Representa uma guia individual e o estado que ela deve ter. Para obter exemplos de código, consulte Alterar a disponibilidade de comandos de suplemento e Criar guias contextuais personalizadas.

Comentários

Conjunto de requisitos: RibbonApi 1.1

Usada por

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 controles na guia, como itens de menu, botões etc.
groups

Especifica um ou mais grupos de controle na guia.
id

Identificador da guia conforme especificado no manifesto.
visible

Especifica se a guia está visível na faixa de opções. Usado apenas com guias contextuais.

Detalhes da propriedade

controls

Especifica um ou mais dos controles na guia, 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 passado para o requestUpdate método Office.Ribbon, essa propriedade especifica as IDs dos controles cujo status habilitado deve ser alterado. No entanto, se houver uma groups propriedade na guia, essa propriedade será ignorada e as controls propriedades dos grupos especificados deverão ser usadas para alterar o status habilitado.

groups

Especifica um ou mais grupos de controle na guia.

groups?: Group[];

Valor da propriedade

Office.Group[]

Comentários

Quando o Tab objeto faz parte de um objeto Office.RibbonUpdaterData passado para o requestUpdate método de Office.Ribbon, as controls propriedades dos vários objetos Office.Group especificam quais controles têm seu status habilitado alterado; a controls propriedade do Tab objeto é ignorada.

Conjunto de requisitos: RibbonApi 1.1

Exemplos

/**
 * Shows or hides a contextual tab.
 */
async function setContextualTabVisibility(visible: boolean) {
    await Office.ribbon.requestUpdate({
        tabs: [
            {
                id: "ContextualTab1",
                visible: visible,
                groups: [
                {
                    id: "TableToolsGroup",
                    controls: [
                        { id: "FormatTableButton", enabled: true },
                        { id: "SortTableButton", enabled: true },
                    ],
                },
                ],
            },
        ],
    });
}

id

Identificador da guia 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 a guia está visível na faixa de opções. Usado apenas com guias 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);
}