Excel.Application class

Devuelve la versión del motor de cálculo de Excel usada para la última actualización completa.

readonly calculationEngineVersion: number;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.9

Devuelve el modo de cálculo usado en el libro, tal como se define por las constantes en Excel.CalculationMode. Los valores posibles son: Automatic, donde Excel controla el nuevo cálculo;AutomaticExceptTables , donde Excel controla el nuevo cálculo pero omite los cambios en las tablas; Manual, donde el cálculo se realiza cuando el usuario lo solicita. Se trata de una propiedad en tiempo de ejecución. La calculationMode configuración no se conserva en el libro.

calculationMode: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.1 para get, 1.8 para set

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-calculation.yaml

await Excel.run(async (context) => {
  context.application.calculationMode = Excel.CalculationMode.manual;
  context.application.load("calculationMode");
  await context.sync();

  console.log("Current calculation mode: " + context.application.calculationMode);
});

Devuelve el estado del cálculo de la aplicación. Vea Excel.CalculationState para más información.

readonly calculationState: Excel.CalculationState | "Done" | "Calculating" | "Pending";

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.9

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Devuelve la configuración de cálculo iterativo. En Excel para Windows y Mac, la configuración se aplicará a la aplicación Excel. En Excel en la Web y otras plataformas, la configuración se aplicará al libro activo.

readonly iterativeCalculation: Excel.IterativeCalculation;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.9

Recalcula todos los libros abiertos actualmente en Excel.

calculate(calculationType: Excel.CalculationType): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.1

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/performance-optimization.yaml

await Excel.run(async (context) => {
  context.application.calculate(Excel.CalculationType.full);
});

Recalcula todos los libros abiertos actualmente en Excel.

calculate(calculationType: "Recalculate" | "Full" | "FullRebuild"): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.1

Ejemplos

await Excel.run(async (context) => {
    context.workbook.application.calculate('Full');
    await context.sync();
});

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.ApplicationLoadOptions): Excel.Application;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Excel.Application;

Parámetros

Devoluciones

Ejemplos

await Excel.run(async (context) => {
    const application = context.workbook.application;
    application.load('calculationMode');
    await context.sync();

    console.log(application.calculationMode);
});

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Application;

Parámetros

Devoluciones

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.

set(properties: Interfaces.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

set(properties: Excel.Application): void;

Parámetros

Devoluciones

Suspende el cálculo hasta que se llama al siguiente context.sync() . Una vez establecido, será responsabilidad del desarrollador actualizar el libro para asegurarse de que se propaguen las dependencias.

suspendApiCalculationUntilNextSync(): void;

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.6

Suspende la actualización de pantalla hasta que se llama a la siguiente context.sync() .

Nota: No llame suspendScreenUpdatingUntilNextSync repetidamente (como en un bucle). Las llamadas repetidas harán que la ventana de Excel parpadee.

suspendScreenUpdatingUntilNextSync(): void;

Devoluciones

Comentarios

Conjunto de API: ExcelApi 1.9

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/performance-optimization.yaml

await Excel.run(async (context) => {
  // Recreate the data in the worksheet with random data.
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  const startTime = Date.now();
  console.log("Starting...");

  // If other parts of the sample have toggled screen painting off, this will stop screen updating until context.sync is called.
  if (pauseScreenPainting) {
    context.application.suspendScreenUpdatingUntilNextSync();
  }

  for (let i = 1; i < ROW_COUNT; i++) {
    for (let j = 1; j < COLUMN_COUNT; j++) {
      let cell = sheet.getCell(i, j);
      cell.values = [[i * j * Math.random()]];

      // If other parts of the sample have toggled tracking off, we will avoid tracking this range and having to manage the proxy objects.
      // For more information, see https://learn.microsoft.com/office/dev/add-ins/concepts/resource-limits-and-performance-optimization#untrack-unneeded-proxy-objects
      if (untrack) {
        cell.untrack();
      }
    }
  }

  await context.sync();

  console.log(`Ending. Adding ${ROW_COUNT * COLUMN_COUNT} cells took ${Date.now() - startTime} milliseconds`);
});

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.Application es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.ApplicationData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Excel.Interfaces.ApplicationData;

Devoluciones