Configurar un documento para que ejecute el código cuando se abra

Puede configurar el complemento de Office para cargar y ejecutar código en cuanto se abra el documento. Esto es útil si necesita registrar controladores de eventos, cargar previamente datos para el panel de tareas, sincronizar la interfaz de usuario o realizar otras tareas antes de que el complemento sea visible.

La configuración se implementa con un método al que el código llama en tiempo de ejecución. Esto significa que el complemento no se ejecutará la primera vez que un usuario abra el documento. El complemento debe abrirse manualmente por primera vez en cualquier documento. Después de que se ejecute el método, ya sea en Office.initialize, Office.onReady o porque el usuario toma una ruta de acceso de código que lo ejecuta; A continuación, cada vez que se vuelve a abrir el documento, el complemento se carga inmediatamente y se ejecuta cualquier código del Office.initialize método OR Office.onReady .

Configurar el complemento para que se cargue cuando se abra el documento

El siguiente código configura el complemento para que se cargue y empiece a ejecutarse cuando se abra el documento.

Office.addin.setStartupBehavior(Office.StartupBehavior.load);

Colocar código de inicio en Office.initialize o Office.onReady

Cuando el complemento esté configurado para cargarse al abrir un documento, se ejecutará inmediatamente. Se Office.initialize llamará al controlador de eventos. Coloque el código de inicio en el Office.initialize controlador de eventos o Office.onReady .

El siguiente código de complemento de Excel muestra cómo registrar un controlador de eventos para eventos de cambios de la hoja de cálculo activa. Si configura el complemento para cargarlo al abrir un documento, este código registrará el controlador de eventos cuando se abra el documento. Puede controlar los eventos de cambio antes de que se abra el panel de tareas.

// This is called as soon as the document opens.
// Put your startup code here.
Office.initialize = () => {
  // Add the event handler.
  Excel.run(async context => {
    let sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.onChanged.add(onChange);

    await context.sync();
    console.log("A handler has been registered for the onChanged event.");
  });
};

/**
 * Handle the changed event from the worksheet.
 *
 * @param event The event information from Excel
 */
async function onChange(event) {
    await Excel.run(async (context) => {    
        await context.sync();
        console.log("Change type of event: " + event.changeType);
        console.log("Address of event: " + event.address);
        console.log("Source of event: " + event.source);
  });
}

El siguiente código de complemento de PowerPoint muestra cómo registrar un controlador de eventos para eventos de cambio de selección del documento de PowerPoint. Si configura el complemento para cargarlo al abrir un documento, este código registrará el controlador de eventos cuando se abra el documento. Puede controlar los eventos de cambio antes de que se abra el panel de tareas.

// This is called as soon as the document opens.
// Put your startup code here.
Office.onReady(info => {
  if (info.host === Office.HostType.PowerPoint) {
    Office.context.document.addHandlerAsync(Office.EventType.DocumentSelectionChanged, onChange);
    console.log("A handler has been registered for the onChanged event.");
  }
});

/**
 * Handle the changed event from the PowerPoint document.
 *
 * @param event The event information from PowerPoint
 */
async function onChange(event) {
  console.log("Change type of event: " + event.type);
}

Configurar el complemento para que no se cargue al abrir un documento

Puede haber escenarios en los que quiera desactivar el comportamiento "Ejecutar al abrir el documento". El siguiente código configura el complemento para que no se inicie al abrir el documento. En su lugar, se iniciará cuando el usuario lo involucre de alguna manera, como elegir un botón de la cinta o abrir el panel de tareas. Este código no tiene ningún efecto si el método no se ha llamado previamente en el documento actual, con Office.StartupBehavior.load el parámetro como parámetro.

Office.addin.setStartupBehavior(Office.StartupBehavior.none);

Obtener el comportamiento de carga actual

Puede haber escenarios en los que el complemento necesite saber si está configurado para iniciarse automáticamente la próxima vez que se abra el documento actual. Para determinar cuál es el comportamiento de inicio actual, ejecute el siguiente método, que devuelve un valor Office.StartupBehavior .

let behavior = await Office.addin.getStartupBehavior();

Vea también

• Configure el complemento de Office para usar un entorno de ejecución compartido
• Compartir datos y eventos entre Excel, funciones personalizadas y panel de tareas tutorial
• Trabajar con Eventos mediante la API de JavaScript de Excel
• Entornos de ejecución en complementos de Office
• Administrar opciones de confianza para complementos de Office