OfficeExtension.ClientRequestContext class

Pacote:

office

Um objeto RequestContext abstrato que facilita solicitações para o aplicativo do Office. Os Excel.run métodos e Word.run fornecem um contexto de solicitação.

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 rastreados para ajustes automáticos com base em alterações ao redor 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)	Enfileira um comando para carregar recursivamente as propriedades especificadas do objeto e suas propriedades de navegação. Você deve chamar context.sync() antes de ler as propriedades.
sync(passThroughValue)	Sincroniza o estado entre objetos proxy JavaScript e o documento do Office, executando instruções enfileiradas no contexto da solicitação e recuperando propriedades de objetos carregados do Office para uso em seu código. Esse método retorna uma promessa, que é resolvida quando a sincronização é concluída.
trace(message)	Adiciona uma mensagem de rastreamento à fila. Se a promessa retornada por context.sync() for rejeitada devido a um erro, isso adicionará uma matriz ".traceMessages" ao objeto OfficeExtension.Error, contendo todas as mensagens de rastreamento executadas. Essas mensagens podem ajudá-lo a monitorar a sequência de execução do programa e detectar 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 rastreados para ajustes automáticos com base em alterações ao redor 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas ou um objeto OfficeExtension.LoadOption .

Retornos

void

loadRecursive(object, options, maxDepth)

Enfileira um comando para carregar recursivamente as propriedades especificadas do objeto e suas 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 ser carregado.

options

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

O emparelhamento de valor-chave de 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 objetos proxy JavaScript e o documento do Office, executando instruções enfileiradas no contexto da solicitação e recuperando propriedades de objetos carregados do Office para uso em seu código. Esse método retorna 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 rastreamento à fila. Se a promessa retornada por context.sync() for rejeitada devido a um erro, isso adicionará uma matriz ".traceMessages" ao objeto OfficeExtension.Error, contendo todas as mensagens de rastreamento executadas. Essas mensagens podem ajudá-lo a monitorar a sequência de execução do programa e detectar a causa do erro.

trace(message: string): void;

Parâmetros

message

string

Retornos

void