Word.XmlNode class

获取此 XML 节点的属性。 null如果节点类型为 ，attribute则返回 。

readonly attributes: Word.XmlNodeCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取不带任何前缀的元素的名称。

readonly baseName: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取此 XML 节点的子元素。 如果节点类型为 attribute，则返回空集合。

readonly childNodes: Word.XmlNodeCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

context: RequestContext;

属性值

如果这是父节点，则获取第一个子节点。 null如果节点类型为 ，attribute则返回 。

readonly firstChild: Word.XmlNode;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取此 XML 节点是否具有子节点。 false始终返回属性节点，因为它们不能有子级。

readonly hasChildNodes: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

如果这是父节点，则获取最后一个子节点。 null如果节点类型为 ，attribute则返回 。

readonly lastChild: Word.XmlNode;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取此 XML 元素是段落的一部分、是段落还是包含在表单元格中或包含表行。 null如果节点类型为 ，attribute则返回 。

readonly level: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell";

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取此 XML 节点的架构命名空间的统一资源标识符 (URI) 。

readonly namespaceUri: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取文档中与此 XML 节点位于同一级别的下一个元素。 null如果节点类型为 ，attribute则返回 。

readonly nextSibling: Word.XmlNode;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取此 XML 节点的父文档。

readonly ownerDocument: Word.Document;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取此 XML 节点的父元素。

readonly parentNode: Word.XmlNode;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定如果此元素不包含文本，则为该元素显示的文本。 仅适用于元素节点，不适用于属性节点。

placeholderText: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取文档中的上一个元素，该元素与此 XML 节点位于同一级别。 null如果节点类型为 ，attribute则返回 。

readonly previousSibling: Word.XmlNode;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取此 XML 节点中包含的文档部分。 null如果节点类型为 ，attribute则返回 。

readonly range: Word.Range;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定 XML 元素中包含的文本。 如果节点类型为 attribute，则返回空字符串。

text: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取节点的类型。

readonly type: Word.XmlNodeType | "Element" | "Attribute";

属性值

注解

[ API 集：WordApi BETA (仅预览版) ]

获取此 XmlNode 对象上验证错误的说明。 对于属性节点可能没有意义。

readonly validationErrorText: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

根据附加的架构获取此元素是否有效。 对于属性节点可能没有意义。

readonly validationStatus: Word.XmlValidationStatus | "Ok" | "Custom";

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定此 XML 节点的值。 对于元素节点， 表示文本内容;对于属性节点，则表示属性值。

value: string;

属性值

注解

[ API 集：WordApi BETA (仅预览版) ]

将此 XML 节点（不包括 XML 标记）复制到剪贴板。 对于属性节点，仅将属性值复制为文本。

copy(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

从文档中删除此 XML 节点并将其放在剪贴板上。 对于属性节点，从其父元素中删除 属性，仅将属性值作为文本复制到剪贴板。

cut(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

从 XML 文档中删除 XML 节点。 对于元素节点，删除整个元素及其内容;对于属性节点，则从其父元素中删除 属性。

delete(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

load(options?: Word.Interfaces.XmlNodeLoadOptions): Word.XmlNode;

参数

返回

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

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

参数

返回

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

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

参数

返回

从此 XML 节点中删除子元素。 如果节点类型 (attribute ，则此方法不起作用，因为属性节点没有) 子元素。

removeChild(childElement: Word.XmlNode): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

返回与 XPath 参数匹配的所有子元素，并按它们在此 XML 节点中的显示顺序。 null如果节点类型 (，attribute则返回 ，因为属性节点没有要搜索) 的子元素。

selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection;

参数

返回

与 XPath 表达式匹配的 XML 节点的集合。

注解

[ API 集：WordApiDesktop 1.4 ]

返回与此 XML 节点中的 XPath 参数匹配的第一个子元素。 null如果节点类型 (，attribute则返回 ，因为属性节点没有要搜索) 的子元素。

selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode;

参数

返回

与 XPath 表达式匹配的第一个 XML 节点，如果未 null 找到匹配项，则为 。

注解

[ API 集：WordApiDesktop 1.4 ]

更改显示给此 XML 节点的用户的验证错误文本，以及是否强制Word将节点报告为无效。 对于属性节点可能没有意义。

setValidationError(status: Word.XmlValidationStatus, options?: Word.XmlNodeSetValidationErrorOptions): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

更改显示给此 XML 节点的用户的验证错误文本，以及是否强制Word将节点报告为无效。 对于属性节点可能没有意义。

setValidationError(status: "Ok" | "Custom", options?: Word.XmlNodeSetValidationErrorOptions): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

toJSON(): Word.Interfaces.XmlNodeData;

返回

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

track(): Word.XmlNode;

返回

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

untrack(): Word.XmlNode;

返回

根据附加到文档的 XML 架构验证此 XML 节点。 对于属性节点可能没有意义。

validate(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]