Excel.Application class

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

Extends

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

calculationState

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

context

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.

cultureInfo

Proporciona información basada en la configuración actual de la cultura del sistema. Esto incluye los nombres de referencia cultural, el formato de número y otras configuraciones que dependen de la cultura cultural.

decimalSeparator

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

iterativeCalculation

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.

thousandsSeparator

Obtiene la cadena que se usa para separar grupos de dígitos a la izquierda del decimal para 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(calculationType)

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 API del mismo tipo.

set(properties)

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

suspendApiCalculationUntilNextSync()

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.

suspendScreenUpdatingUntilNextSync()

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.

toJSON()

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.

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

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

Comentarios

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

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

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

cultureInfo

Proporciona información basada en la configuración actual de la cultura del sistema. Esto incluye los nombres de referencia cultural, el formato de número y otras configuraciones que dependen de la cultura cultural.

readonly cultureInfo: Excel.CultureInfo;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.11]

decimalSeparator

Obtiene la cadena usada como separador decimal para 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]

iterativeCalculation

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]

thousandsSeparator

Obtiene la cadena que se usa para separar grupos de dígitos a la izquierda del decimal para 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]

calculate(calculationType)

Recalcula todos los libros abiertos actualmente en Excel.

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

Parámetros

calculationType

"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]

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

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

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

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 API del mismo tipo.

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

Parámetros

properties
Excel.Interfaces.ApplicationUpdateData

Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el 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, basadas en un objeto cargado existente.

set(properties: Excel.Application): void;

Parámetros

properties
Excel.Application

Devoluciones

void

suspendApiCalculationUntilNextSync()

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

void

Comentarios

[Conjunto de API: ExcelApi 1.6]

suspendScreenUpdatingUntilNextSync()

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

void

Comentarios

[Conjunto de API: ExcelApi 1.9]

toJSON()

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