Compartir a través de

Excel.Application class

  • Referencia
Paquete:
excel

Representa la aplicación de Excel que administra el libro.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Propiedades

calculationEngineVersion

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

Devuelve el modo de cálculo usado en el libro, tal como se define en las constantes de Excel.CalculationMode. Los valores posibles son: Automatic, donde Excel controla la actualización;AutomaticExceptTables , donde Excel controla la actualización pero omite los cambios en las tablas; Manual, donde se realiza el cálculo cuando el usuario lo solicita.
calculationState

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

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
cultureInfo

Proporciona información basada en la configuración actual de la referencia cultural del sistema. Esto incluye los nombres de referencia cultural, el formato de números y otras configuraciones culturalmente dependientes.
decimalSeparator

Obtiene la cadena utilizada como separador decimal para los valores numéricos. Esto se basa en la configuración local de Excel.
formatStaleValues

Especifica si la opción Formato de valores obsoletos en Opciones de cálculo está habilitada o deshabilitada. Las fórmulas obsoletas se representan con formato obsoleto si la opción está habilitada.
iterativeCalculation

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

Obtiene la cadena usada para separar grupos de dígitos a la izquierda del decimal para los valores numéricos. Esto se basa en la configuración local de Excel.
useSystemSeparators

Especifica si los separadores del sistema de Excel están habilitados. Los separadores del sistema incluyen el separador decimal y el separador de miles.

Métodos

calculate(calculationType)

Recalcula todos los libros abiertos actualmente en Excel.
calculate(calculationTypeString)

Recalcula todos los libros abiertos actualmente en Excel.
load(options)

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

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

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

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

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
suspendApiCalculationUntilNextSync()

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

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

Nota*: No llames repetidamente suspendScreenUpdatingUntilNextSync (por ejemplo, en un bucle). Las llamadas repetidas harán que la ventana de Excel parpade.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.Application original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ApplicationData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

calculationEngineVersion

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

readonly calculationEngineVersion: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

calculationMode

Devuelve el modo de cálculo usado en el libro, tal como se define en las constantes de Excel.CalculationMode. Los valores posibles son: Automatic, donde Excel controla la actualización;AutomaticExceptTables , donde Excel controla la actualización pero omite los cambios en las tablas; Manual, donde se realiza el cálculo cuando el usuario lo solicita.

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

Valor de propiedad

Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"

Comentarios

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

calculationState

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

Excel.CalculationState | "Done" | "Calculating" | "Pending"

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

cultureInfo

Proporciona información basada en la configuración actual de la referencia cultural del sistema. Esto incluye los nombres de referencia cultural, el formato de números y otras configuraciones culturalmente dependientes.

readonly cultureInfo: Excel.CultureInfo;

Valor de propiedad

Excel.CultureInfo

Comentarios

[ Conjunto de API: ExcelApi 1.11 ]

decimalSeparator

Obtiene la cadena utilizada como separador decimal para los valores numéricos. Esto se basa en la configuración local de Excel.

readonly decimalSeparator: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.11 ]

Ejemplos

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

await Excel.run(async (context) => {
  context.application.load("decimalSeparator,thousandsSeparator");
  context.application.cultureInfo.numberFormat.load("numberDecimalSeparator,numberGroupSeparator");
  await context.sync();

  // Local settings are set under the "Options > Advanced" menu.
  const localDecimalSeparator = context.application.decimalSeparator;
  const localThousandsSeparator = context.application.thousandsSeparator;

  const systemDecimalSeparator = context.application.cultureInfo.numberFormat.numberDecimalSeparator;
  const systemThousandsSeparator = context.application.cultureInfo.numberFormat.numberGroupSeparator;

  console.log("Local character settings: ");
  console.log(`  Local decimal separator: ${localDecimalSeparator}`);
  console.log(`  Local thousands separator: ${localThousandsSeparator}`);

  console.log("System culture settings: ");
  console.log(`  System decimal separator: ${systemDecimalSeparator}`);
  console.log(`  System thousands separator: ${systemThousandsSeparator}`);
  console.log(`  `);

  await context.sync();
});

formatStaleValues

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica si la opción Formato de valores obsoletos en Opciones de cálculo está habilitada o deshabilitada. Las fórmulas obsoletas se representan con formato obsoleto si la opción está habilitada.

formatStaleValues: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

iterativeCalculation

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

readonly iterativeCalculation: Excel.IterativeCalculation;

Valor de propiedad

Excel.IterativeCalculation

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

thousandsSeparator

Obtiene la cadena usada para separar grupos de dígitos a la izquierda del decimal para los valores numéricos. Esto se basa en la configuración local de Excel.

readonly thousandsSeparator: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.11 ]

useSystemSeparators

Especifica si los separadores del sistema de Excel están habilitados. Los separadores del sistema incluyen el separador decimal y el separador de miles.

readonly useSystemSeparators: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.11 ]

Detalles del método

calculate(calculationType)

Recalcula todos los libros abiertos actualmente en Excel.

calculate(calculationType: Excel.CalculationType): void;

Parámetros

calculationType
Excel.CalculationType

Especifica el tipo de cálculo que se va a usar. Vea Excel.CalculationType para más información.

Devoluciones

void

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

calculate(calculationTypeString)

Recalcula todos los libros abiertos actualmente en Excel.

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

Parámetros

calculationTypeString

"Recalculate" | "Full" | "FullRebuild"

Especifica el tipo de cálculo que se va a usar. Vea Excel.CalculationType para más información.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

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

load(options)

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

options
Excel.Interfaces.ApplicationLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.Application

load(propertyNames)

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

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.Application

Ejemplos

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

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

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.Application

set(properties, options)

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

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

Parámetros

properties
Excel.Interfaces.ApplicationUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options
OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Excel.Application): void;

Parámetros

properties
Excel.Application

Devoluciones

void

suspendApiCalculationUntilNextSync()

Suspende el cálculo hasta que se llame 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

void

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

suspendScreenUpdatingUntilNextSync()

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

Nota*: No llames repetidamente suspendScreenUpdatingUntilNextSync (por ejemplo, en un bucle). Las llamadas repetidas harán que la ventana de Excel parpade.

suspendScreenUpdatingUntilNextSync(): void;

Devoluciones

void

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

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.Application original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ApplicationData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.ApplicationData;

Devoluciones

Excel.Interfaces.ApplicationData