Office.Addin interface

  • Referencia
Paquete:
office

Representa la funcionalidad de nivel de complemento para operar o configurar varios aspectos del complemento.

Comentarios

Conjunto de requisitos: SharedRuntime 1.1

Propiedades

beforeDocumentCloseNotification

Representa un cuadro de diálogo de notificación modal que puede aparecer cuando el usuario intenta cerrar un documento. El documento no se cerrará hasta que el usuario responda. Esta API solo se admite en Excel.

Métodos

getStartupBehavior()

Obtiene el comportamiento de inicio actual del complemento.
hide()

Oculta el panel de tareas.
onVisibilityModeChanged(handler)

Agrega un controlador para el onVisibilityModeChanged evento .
setStartupBehavior(behavior)

Establece el comportamiento de inicio del complemento para cuando se abra el documento la próxima vez.
showAsTaskpane()

Muestra el panel de tareas asociado al complemento.

Detalles de las propiedades

beforeDocumentCloseNotification

Representa un cuadro de diálogo de notificación modal que puede aparecer cuando el usuario intenta cerrar un documento. El documento no se cerrará hasta que el usuario responda. Esta API solo se admite en Excel.

beforeDocumentCloseNotification: BeforeDocumentCloseNotification;

Valor de propiedad

Office.BeforeDocumentCloseNotification

Comentarios

Conjunto de requisitos: SharedRuntime 1.2

Detalles del método

getStartupBehavior()

Obtiene el comportamiento de inicio actual del complemento.

getStartupBehavior(): Promise<Office.StartupBehavior>;

Devoluciones

Promise<Office.StartupBehavior>

Comentarios

Conjunto de requisitos: SharedRuntime 1.1

hide()

Oculta el panel de tareas.

hide(): Promise<void>;

Devoluciones

Promise<void>

Una promesa que se resuelve cuando la interfaz de usuario está oculta.

Comentarios

Conjunto de requisitos: SharedRuntime 1.1

onVisibilityModeChanged(handler)

Agrega un controlador para el onVisibilityModeChanged evento .

onVisibilityModeChanged(
            handler: (message: VisibilityModeChangedMessage) => void,
        ): Promise<() => Promise<void>>;

Parámetros

handler

(message: Office.VisibilityModeChangedMessage) => void

Función de controlador a la que se llama cuando se emite el evento. Esta función toma un mensaje para el componente receptor.

Devoluciones

Promise<() => Promise<void>>

Promesa que se resuelve en una función cuando se agrega el controlador. Si se llama, se quita el controlador.

Comentarios

Conjunto de requisitos: SharedRuntime 1.1

Ejemplos

Office.onReady(() => {
    Office.addin.onVisibilityModeChanged((args) => {
        if (args.visibilityMode === Office.VisibilityMode.taskpane) {
            // Do something when the task pane is visible.
        }
    });

    // Other startup tasks.
});

setStartupBehavior(behavior)

Establece el comportamiento de inicio del complemento para cuando se abra el documento la próxima vez.

setStartupBehavior(behavior: Office.StartupBehavior): Promise<void>;

Parámetros

behavior
Office.StartupBehavior

Especifica el comportamiento de inicio del complemento.

Devoluciones

Promise<void>

Comentarios

Conjunto de requisitos: SharedRuntime 1.1

Ejemplos

// Configure your add-in to load and start running when the document is opened.
Office.addin.setStartupBehavior(Office.StartupBehavior.load);

showAsTaskpane()

Muestra el panel de tareas asociado al complemento.

showAsTaskpane(): Promise<void>;

Devoluciones

Promise<void>

Una promesa que se resuelve cuando se muestra la interfaz de usuario.

Comentarios

Conjunto de requisitos: SharedRuntime 1.1