Word.XmlMapping class

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

返回一个 CustomXmlNode 对象，该对象表示文档中内容控件映射到的数据存储中的自定义 XML 节点。

readonly customXmlNode: Word.CustomXmlNode;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回一个 CustomXmlPart 对象，该对象表示文档中的内容控件映射到的自定义 XML 部件。

readonly customXmlPart: Word.CustomXmlPart;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回文档中的内容控件是否映射到文档的 XML 数据存储中的 XML 节点。

readonly isMapped: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回用于评估当前 XML 映射的 XPath 的前缀映射。

readonly prefixMappings: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回 XML 映射的 XPath，该映射的计算结果为当前映射的 XML 节点。

readonly xpath: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

从父内容控件中删除 XML 映射。

delete(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

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

load(options?: Word.Interfaces.XmlMappingLoadOptions): Word.XmlMapping;

参数

返回

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

load(propertyNames?: string | string[]): Word.XmlMapping;

参数

返回

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.XmlMapping;

参数

返回

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.XmlMappingUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

返回

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Word.XmlMapping): void;

参数

返回

允许在内容控件上创建或更改 XML 映射。

setMapping(xPath: string, options?: Word.XmlSetMappingOptions): OfficeExtension.ClientResult<boolean>;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

允许在内容控件上创建或更改 XML 数据映射。

setMappingByNode(node: Word.CustomXmlNode): OfficeExtension.ClientResult<boolean>;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.XmlMapping对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.XmlMappingData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Word.Interfaces.XmlMappingData;

返回

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.XmlMapping;

返回

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.XmlMapping;

返回