Office.Group interface

Pacote:
office

Representa um grupo de controles em uma guia da faixa de opções.

Conjunto de requisitos: RibbonApi 1.1

Comentários

Usada por

Exemplos

/**
 * Shows or hides a contextual tab.
 */
async function setContextualTabVisibility(visible: boolean) {
    // Define a tab group of controls.
    const group: Office.Group = {
        id: "TableToolsGroup",
        controls: [
            // The controls of the group...
        ],
    };
    
    // Update the ribbon to show or hide a tab with the specified group of controls.
    await Office.ribbon.requestUpdate({
        tabs: [
            {
                id: "contextTab1",
                visible: visible,
                groups: [group],
            },
        ],
    });
}

Propriedades

controls

Especifica um ou mais controles no grupo, como itens de menu, botões etc.
id

Identificador do grupo, conforme especificado no manifesto.
visible

Especifica se o grupo de controles é mostrado ou oculto em uma guia personalizada.

Detalhes da propriedade

controls

Especifica um ou mais controles no grupo, como itens de menu, botões etc.

controls?: Control[];

Valor da propriedade

Office.Control[]

Comentários

Quando o Group 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 objeto pai Tab do Group objeto é ignorada.

id

Identificador do grupo, conforme especificado no manifesto.

id: string;

Valor da propriedade

string

visible

Especifica se o grupo de controles é mostrado ou oculto em uma guia personalizada.

visible?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de requisitos: RibbonApi 1.3

Exemplos

// Hide the Reporting Group from the User Tools tab on the ribbon.
const group: Office.Group = {
    id: "Contoso.ReportingGroup",
    visible: false
};
const tab: Office.Tab = {
    id: "Contoso.UserToolsTab",
    groups: [group]
};
// Apply the change to the ribbon.
const ribbonUpdater: Office.RibbonUpdaterData = { tabs: [tab] };
await Office.ribbon.requestUpdate(ribbonUpdater);