Office.Group interface

Paquete:
office

Representa un grupo de controles en una pestaña de la cinta de opciones.

Conjunto de requisitos: RibbonApi 1.1

Comentarios

Usada por

Ejemplos

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

Propiedades

controls

Especifica uno o varios de los controles del grupo, como los elementos de menú, los botones, etc.
id

Identificador del grupo tal y como se especifica en el manifiesto.
visible

Especifica si el grupo de controles se muestra u oculta en una pestaña personalizada.

Detalles de las propiedades

controls

Especifica uno o varios de los controles del grupo, como los elementos de menú, los botones, etc.

controls?: Control[];

Valor de propiedad

Office.Control[]

Comentarios

Cuando el Group objeto forma parte de un objeto Office.RibbonUpdaterData pasado al requestUpdate método de Office.Ribbon, las controls propiedades de los distintos objetos Office.Group especifican qué controles han cambiado su estado habilitado; la controls propiedad Group del objeto primario Tab del objeto se omite.

id

Identificador del grupo tal y como se especifica en el manifiesto.

id: string;

Valor de propiedad

string

visible

Especifica si el grupo de controles se muestra u oculta en una pestaña personalizada.

visible?: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de requisitos: RibbonApi 1.3

Ejemplos

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