OfficeExtension.ClientRequestContext class

  • Referencia
Paquete:
office

Objeto RequestContext abstracto que facilita las solicitudes a la aplicación de Office. Los Excel.run métodos y Word.run proporcionan un contexto de solicitud.

Constructores

(constructor)(url)

Construye una nueva instancia de la ClientRequestContext clase

Propiedades

debugInfo

Información de depuración
requestHeaders

Encabezados de solicitud
trackedObjects

Colección de objetos a los que se realiza el seguimiento de los ajustes automáticos en función de los cambios circundantes en el documento.

Métodos

load(object, option)

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

Pone en cola un comando para cargar de forma recursiva las propiedades especificadas del objeto y sus propiedades de navegación.

Debe llamar a context.sync() antes de leer las propiedades.
sync(passThroughValue)

Sincroniza el estado entre los objetos de proxy de JavaScript y el documento de Office mediante la ejecución de instrucciones en cola en el contexto de solicitud y la recuperación de propiedades de objetos de Office cargados para su uso en el código. Este método devuelve una promesa, que se resuelve cuando se completa la sincronización.
trace(message)

Agrega un mensaje de seguimiento a la cola. Si la promesa devuelta por se rechaza debido context.sync() a un error, agrega una matriz ".traceMessages" al objeto OfficeExtension.Error, que contiene todos los mensajes de seguimiento que se ejecutaron. Estos mensajes pueden ayudarle a supervisar la secuencia de ejecución del programa y detectar la causa del error.

Detalles del constructor

(constructor)(url)

Construye una nueva instancia de la ClientRequestContext clase

constructor(url?: string);

Parámetros

url

string

Detalles de las propiedades

debugInfo

Información de depuración

readonly debugInfo: RequestContextDebugInfo;

Valor de propiedad

OfficeExtension.RequestContextDebugInfo

requestHeaders

Encabezados de solicitud

requestHeaders: { [name: string]: string };

Valor de propiedad

{ [name: string]: string }

trackedObjects

Colección de objetos a los que se realiza el seguimiento de los ajustes automáticos en función de los cambios circundantes en el documento.

trackedObjects: TrackedObjects;

Valor de propiedad

OfficeExtension.TrackedObjects

Detalles del método

load(object, option)

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

load(object: ClientObject, option?: string | string[] | LoadOption): void;

Parámetros

object
OfficeExtension.ClientObject

Objeto cuyas propiedades se cargan.

option

string | string[] | OfficeExtension.LoadOption

Cadena delimitada por comas, o matriz de cadenas, que especifica las propiedades que se van a cargar o un objeto OfficeExtension.LoadOption .

Devoluciones

void

loadRecursive(object, options, maxDepth)

Pone en cola un comando para cargar de forma recursiva las propiedades especificadas del objeto y sus propiedades de navegación.

Debe llamar a context.sync() antes de leer las propiedades.

loadRecursive(object: ClientObject, options: { [typeName: string]: string | string[] | LoadOption }, maxDepth?: number): void;

Parámetros

object
OfficeExtension.ClientObject

Objeto que se va a cargar.

options

{ [typeName: string]: string | string[] | OfficeExtension.LoadOption }

Emparejamiento clave-valor de las opciones de carga para los tipos, como { "Workbook": "worksheets,tables", "Worksheet": "tables", "Tables": "name" }

maxDepth

number

Profundidad recursiva máxima.

Devoluciones

void

sync(passThroughValue)

Sincroniza el estado entre los objetos de proxy de JavaScript y el documento de Office mediante la ejecución de instrucciones en cola en el contexto de solicitud y la recuperación de propiedades de objetos de Office cargados para su uso en el código. Este método devuelve una promesa, que se resuelve cuando se completa la sincronización.

sync<T>(passThroughValue?: T): Promise<T>;

Parámetros

passThroughValue

T

Devoluciones

Promise<T>

trace(message)

Agrega un mensaje de seguimiento a la cola. Si la promesa devuelta por se rechaza debido context.sync() a un error, agrega una matriz ".traceMessages" al objeto OfficeExtension.Error, que contiene todos los mensajes de seguimiento que se ejecutaron. Estos mensajes pueden ayudarle a supervisar la secuencia de ejecución del programa y detectar la causa del error.

trace(message: string): void;

Parámetros

message

string

Devoluciones

void