Office.Tab interface

Paquete:

office

Representa una pestaña individual y el estado que debe tener. Para ver ejemplos de código, vea Habilitar y deshabilitar comandos de complemento yCrear pestañas contextuales personalizadas.

Comentarios

Conjunto de requisitos: RibbonAPI 1.1

Ejemplos

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

Propiedades

controls	Especifica uno o varios de los controles de la pestaña, como elementos de menú, botones, etc.
groups	Especifica uno o varios de los grupos de controles de la pestaña.
id	Identificador de la pestaña tal como se especifica en el manifiesto.
visible	Especifica si la pestaña está visible en la cinta de opciones. Solo se usa con pestañas contextuales.

Detalles de las propiedades

controls

Especifica uno o varios de los controles de la pestaña, como elementos de menú, botones, etc.

controls?: Control[];

Valor de propiedad

Office.Control[]

Comentarios

Cuando el Tab objeto forma parte de un objeto Office.RibbonUpdaterData pasado al requestUpdate método de Office.Ribbon, esta propiedad especifica los identificadores de los controles cuyo estado habilitado se va a cambiar. Sin embargo, si hay una groups propiedad en la pestaña, esta propiedad se omite y se deben usar las controls propiedades de los grupos especificados para cambiar el estado habilitado.

groups

Especifica uno o varios de los grupos de controles de la pestaña.

groups?: Group[];

Valor de propiedad

Office.Group[]

Comentarios

Cuando el Tab 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 tienen su estado habilitado cambiado; se omite la controls propiedad del Tab objeto.

Conjunto de requisitos: RibbonAPI 1.1

id

Identificador de la pestaña tal como se especifica en el manifiesto.

id: string;

Valor de propiedad

string

Ejemplos

// 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 si la pestaña está visible en la cinta de opciones. Solo se usa con pestañas contextuales.

visible?: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de requisitos: RibbonAPI 1.2

Ejemplos

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