Word.XmlMapping class
表示 Word 上的 XML 映射。ContentControl 对象。 XML 映射是内容控件中的文本与此文档的自定义 XML 数据存储中的 XML 元素之间的链接。
注解
使用方
属性
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| custom |
返回一个 |
| custom |
返回一个 |
| is |
返回文档中的内容控件是否映射到文档的 XML 数据存储中的 XML 节点。 |
| prefix |
返回用于计算当前 XML 映射的 XPath 的前缀映射。 |
| xpath | 返回 XML 映射的 XPath，该映射的计算结果为当前映射的 XML 节点。 |
方法
| delete() | 从父内容控件中删除 XML 映射。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| set |
允许在内容控件上创建或更改 XML 映射。 |
| set |
允许在内容控件上创建或更改 XML 数据映射。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
context
customXmlNode
返回一个 CustomXmlNode 对象，该对象表示文档中的内容控件映射到的数据存储中的自定义 XML 节点。
readonly customXmlNode: Word.CustomXmlNode;属性值
注解
customXmlPart
返回一个 CustomXmlPart 对象，该对象表示文档中的内容控件映射到的自定义 XML 部件。
readonly customXmlPart: Word.CustomXmlPart;属性值
注解
isMapped
返回文档中的内容控件是否映射到文档的 XML 数据存储中的 XML 节点。
readonly isMapped: boolean;属性值
boolean
注解
prefixMappings
返回用于计算当前 XML 映射的 XPath 的前缀映射。
readonly prefixMappings: string;属性值
string
注解
xpath
返回 XML 映射的 XPath，该映射的计算结果为当前映射的 XML 节点。
readonly xpath: string;属性值
string
注解
方法详细信息
delete()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.XmlMappingLoadOptions): Word.XmlMapping;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.XmlMapping;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.XmlMapping;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.XmlMappingUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Word.Interfaces.XmlMappingUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
基于现有加载的对象，同时在对象上设置多个属性。
set(properties: Word.XmlMapping): void;参数
- properties
- Word.XmlMapping
返回
void
setMapping(xPath, options)
允许在内容控件上创建或更改 XML 映射。
setMapping(xPath: string, options?: Word.XmlSetMappingOptions): OfficeExtension.ClientResult<boolean>;参数
- xPath
-
string
要计算的 XPath 表达式。
- options
- Word.XmlSetMappingOptions
可选。 可用于设置 XML 映射的选项。
返回
OfficeExtension.ClientResult<boolean>
注解
setMappingByNode(node)
允许在内容控件上创建或更改 XML 数据映射。
setMappingByNode(node: Word.CustomXmlNode): OfficeExtension.ClientResult<boolean>;参数
- node
- Word.CustomXmlNode
要映射的自定义 XML 节点。
返回
OfficeExtension.ClientResult<boolean>
注解
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.XmlMapping 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.XmlMappingData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Word.Interfaces.XmlMappingData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。
track(): Word.XmlMapping;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): Word.XmlMapping;