OfficeExtension.ClientRequestContext class

一个抽象的 RequestContext 对象,该对象有助于向 Office 应用程序发出请求。 Excel.runWord.run 方法提供请求上下文。

构造函数

(constructor)(url)

构造 类的新实例ClientRequestContext

属性

debugInfo

调式信息

requestHeaders

请求标头

trackedObjects

对象的集合,这些对象根据文档中的周围更改自动调整进行跟踪。

方法

load(object, option)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

loadRecursive(object, options, maxDepth)

将命令排队,以递归方式加载对象的指定属性及其导航属性。

阅读属性前必须先调用 context.sync()

sync(passThroughValue)

通过执行在请求上下文上排队的指令并检索加载的 Office 对象的属性以在代码中使用,来同步 JavaScript 代理对象和 Office 文档之间的状态。 此方法返回一个 promise,该承诺在同步完成时解析。

trace(message)

将跟踪消息添加到队列。 如果 由于错误而拒绝 了 返回 context.sync() 的承诺,则会向 OfficeExtension.Error 对象添加一个“.traceMessages”数组,其中包含执行的所有跟踪消息。 这些消息有助于监视程序执行顺序并检测错误的原因。

构造函数详细信息

(constructor)(url)

构造 类的新实例ClientRequestContext

constructor(url?: string);

参数

url

string

属性详细信息

debugInfo

调式信息

readonly debugInfo: RequestContextDebugInfo;

属性值

requestHeaders

请求标头

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

属性值

{ [name: string]: string }

trackedObjects

对象的集合,这些对象根据文档中的周围更改自动调整进行跟踪。

trackedObjects: TrackedObjects;

属性值

方法详细信息

load(object, option)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

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

参数

object
OfficeExtension.ClientObject

加载其属性的对象。

option

string | string[] | OfficeExtension.LoadOption

以逗号分隔的字符串或字符串数组(指定要加载的属性)或 OfficeExtension.LoadOption 对象。

返回

void

loadRecursive(object, options, maxDepth)

将命令排队,以递归方式加载对象的指定属性及其导航属性。

阅读属性前必须先调用 context.sync()

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

参数

object
OfficeExtension.ClientObject

要加载的对象。

options

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

类型的加载选项的键值配对,例如 { "Workbook": "worksheets,tables", "Worksheet": "tables", "Tables": "name" }

maxDepth

number

最大递归深度。

返回

void

sync(passThroughValue)

通过执行在请求上下文上排队的指令并检索加载的 Office 对象的属性以在代码中使用,来同步 JavaScript 代理对象和 Office 文档之间的状态。 此方法返回一个 promise,该承诺在同步完成时解析。

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

参数

passThroughValue

T

返回

Promise<T>

trace(message)

将跟踪消息添加到队列。 如果 由于错误而拒绝 了 返回 context.sync() 的承诺,则会向 OfficeExtension.Error 对象添加一个“.traceMessages”数组,其中包含执行的所有跟踪消息。 这些消息有助于监视程序执行顺序并检测错误的原因。

trace(message: string): void;

参数

message

string

返回

void