Excel.Application class

Paquete:

excel

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

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Propiedades

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.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

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.
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

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 ]

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

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 ]

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