OfficeExtension.ClientRequestContext class

包:

office

有助于请求 Office 应用程序的抽象 RequestContext 对象。 Excel.run and Word.run 方法提供请求上下文。

注解

使用方

• Excel： 运行
• Excel.CustomFunctionManager： newObject
• Excel.DocumentTaskChange： newObject
• OfficeExtension.ClientObject： context
• OfficeExtension.EventHandlerResult： context
• OfficeExtension.RunOptions： previousObjects
• PowerPoint.Application： newObject
• PowerPoint.SensitivityLabelsCatalog： newObject
• Visio： 运行
• Word.应用程序： newObject
• Word.SearchOptions： newObject
• Word.SensitivityLabelsCatalog： newObject

构造函数

(constructor)(url)

构造类的新 ClientRequestContext 实例

属性

debugInfo	调式信息
requestHeaders	请求标头
trackedObjects	跟踪对象的集合，以便根据文档中的周围更改自动调整。

方法

load(object, option)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
loadRecursive(object, options, maxDepth)	将命令队列起来，以递归方式加载对象的指定属性及其导航属性。 阅读属性前必须先调用 context.sync()。
sync(passThroughValue)	通过执行在请求上下文上排队的指令并检索加载的 Office 对象的属性以供在代码中使用，同步 JavaScript 代理对象和 Office 文档之间的状态。 此方法返回一个承诺，该承诺在同步完成后解析。
trace(message)	将跟踪消息添加到队列。 如果返回的 context.sync() 承诺由于错误而被拒绝，则会将“.traceMessages”数组添加到 OfficeExtension.Error 对象，其中包含已执行的所有跟踪消息。 这些消息可以帮助您监控程序执行顺序并检测错误原因。

构造函数详细信息

(constructor)(url)

构造类的新 ClientRequestContext 实例

constructor(url?: string);

参数

url

string

属性详细信息

debugInfo

调式信息

readonly debugInfo: RequestContextDebugInfo;

属性值

OfficeExtension.RequestContextDebugInfo

requestHeaders

请求标头

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

属性值

{ [name: string]: string }

trackedObjects

跟踪对象的集合，以便根据文档中的周围更改自动调整。

trackedObjects: TrackedObjects;

属性值

OfficeExtension.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 文档之间的状态。 此方法返回一个承诺，该承诺在同步完成后解析。

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

参数

passThroughValue

T

返回

Promise<T>

trace(message)

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

trace(message: string): void;

参数

message

string

返回

void