OfficeExtension.ClientRequestContext class

Pacote:

office

Um objeto RequestContext abstrato que facilita os pedidos para a aplicação do Office. Os Excel.run métodos e Word.run fornecem um contexto de pedido.

Construtores

(constructor)(url)

Constrói uma nova instância da ClientRequestContext classe

Propriedades

debugInfo	Informações de depuração
requestHeaders	Cabeçalhos de solicitação
trackedObjects	Coleção de objetos que são monitorizados para ajustes automáticos com base nas alterações adjacentes no documento.

Métodos

load(object, option)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
loadRecursive(object, options, maxDepth)	Coloca em fila um comando para carregar recursivamente as propriedades especificadas do objeto e as respetivas propriedades de navegação. Você deve chamar context.sync() antes de ler as propriedades.
sync(passThroughValue)	Sincroniza o estado entre os objetos proxy javaScript e o documento do Office, executando as instruções em fila no contexto do pedido e obtendo propriedades de objetos carregados do Office para utilização no seu código. Este método devolve uma promessa, que é resolvida quando a sincronização é concluída.
trace(message)	Adiciona uma mensagem de rastreio à fila. Se a promessa devolvida por context.sync() for rejeitada devido a um erro, esta ação adiciona uma matriz ".traceMessages" ao objeto OfficeExtension.Error, que contém todas as mensagens de rastreio que foram executadas. Estas mensagens podem ajudá-lo a monitorizar a sequência de execução do programa e a detetar a causa do erro.

Detalhes do construtor

(constructor)(url)

Constrói uma nova instância da ClientRequestContext classe

constructor(url?: string);

Parâmetros

url

string

Detalhes da propriedade

debugInfo

Informações de depuração

readonly debugInfo: RequestContextDebugInfo;

Valor da propriedade

OfficeExtension.RequestContextDebugInfo

requestHeaders

Cabeçalhos de solicitação

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

Valor da propriedade

{ [name: string]: string }

trackedObjects

Coleção de objetos que são monitorizados para ajustes automáticos com base nas alterações adjacentes no documento.

trackedObjects: TrackedObjects;

Valor da propriedade

OfficeExtension.TrackedObjects

Detalhes do método

load(object, option)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

object

OfficeExtension.ClientObject

O objeto cujas propriedades são carregadas.

option

string | string[] | OfficeExtension.LoadOption

Uma cadeia delimitada por vírgulas, ou matriz de cadeias, que especifica as propriedades a carregar ou um objeto OfficeExtension.LoadOption .

Retornos

void

loadRecursive(object, options, maxDepth)

Coloca em fila um comando para carregar recursivamente as propriedades especificadas do objeto e as respetivas propriedades de navegação.

Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

object

OfficeExtension.ClientObject

O objeto a carregar.

options

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

O emparelhamento chave-valor das opções de carga para os tipos, como { "Workbook": "worksheets,tables", "Worksheet": "tables", "Tables": "name" }

maxDepth

number

A profundidade recursiva máxima.

Retornos

void

sync(passThroughValue)

Sincroniza o estado entre os objetos proxy javaScript e o documento do Office, executando as instruções em fila no contexto do pedido e obtendo propriedades de objetos carregados do Office para utilização no seu código. Este método devolve uma promessa, que é resolvida quando a sincronização é concluída.

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

Parâmetros

passThroughValue

T

Retornos

Promise<T>

trace(message)

Adiciona uma mensagem de rastreio à fila. Se a promessa devolvida por context.sync() for rejeitada devido a um erro, esta ação adiciona uma matriz ".traceMessages" ao objeto OfficeExtension.Error, que contém todas as mensagens de rastreio que foram executadas. Estas mensagens podem ajudá-lo a monitorizar a sequência de execução do programa e a detetar a causa do erro.

trace(message: string): void;

Parâmetros

message

string

Retornos

void