Office.Ribbon interface

Paquete:
office

Una interfaz que contiene todas las funciones proporcionadas para administrar el estado de la cinta de Office.

Comentarios

Conjunto de requisitos: RibbonApi 1.1

Métodos

requestCreateControls(tabDefinition)

Registra una pestaña contextual personalizada en Office y define los controles de la pestaña.
requestUpdate(input)

Envía una solicitud a Office para actualizar la cinta de opciones.

Detalles del método

requestCreateControls(tabDefinition)

Registra una pestaña contextual personalizada en Office y define los controles de la pestaña.

requestCreateControls(tabDefinition: Object): Promise<void>;

Parámetros

tabDefinition

Object

Especifica las propiedades de la pestaña y los controles secundarios y sus propiedades. Este parámetro no está fuertemente tipado porque su forma está definida por un esquema JSON que se puede versionar. Para crear el objeto de parámetro, pase una cadena JSON que se ajuste al esquema JSON de la cinta dinámica de Office a JSON.parsey luego pase el objeto devuelto a este método. Para obtener IntelliSense para JSON en Visual Studio Code, consulte Editar JSON con Visual Studio Code: esquemas y configuración de JSON.

Devoluciones

Promise<void>

Comentarios

Conjunto de requisitos: RibbonApi 1.2

Este método solo solicita que se registre la pestaña. El registro real lo controla la aplicación de Office y es posible que no se complete cuando se resuelva el objeto devuelto Promise . Para obtener más información y ejemplos de código, vea Crear pestañas contextuales personalizadas.

Ejemplos

// Registers a custom contextual tab with Office.
Office.onReady(async () => {
    const contextualTabJSON = ` ... `; // Assign the JSON string.
    const contextualTab = JSON.parse(contextualTabJSON);
    await Office.ribbon.requestCreateControls(contextualTab);
});

requestUpdate(input)

Envía una solicitud a Office para actualizar la cinta de opciones.

requestUpdate(input: RibbonUpdaterData): Promise<void>;

Parámetros

input
Office.RibbonUpdaterData

Representa las actualizaciones que se van a realizar en la cinta de opciones. Tenga en cuenta que solo se realizan los cambios especificados en el parámetro de entrada.

Devoluciones

Promise<void>

Comentarios

Conjunto de requisitos: RibbonApi 1.1

Tenga en cuenta que esta API es solo para solicitar una actualización. La aplicación de Office controla la actualización real de la interfaz de usuario de la cinta y, por lo tanto, la finalización de esta API no puede determinar el momento exacto de la actualización de la cinta.

Para obtener ejemplos de código, vea Cambiar la disponibilidad de los comandos de complemento y Crear pestañas contextuales personalizadas.

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