Word.CustomXmlNode class

获取一个 CustomXmlNodeCollection 对象，该对象表示当前节点中当前元素的特性。

readonly attributes: Word.CustomXmlNodeCollection;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取不带命名空间前缀的节点的基名称（如有）。

readonly baseName: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取包含 CustomXmlNodeCollection 当前节点的所有子元素的 对象。

readonly childNodes: Word.CustomXmlNodeCollection;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

context: RequestContext;

属性值

获取与当前节点的第一个 CustomXmlNode 子元素对应的 对象。 如果节点 (没有子元素，或者如果节点的类型不是 CustomXmlNodeType.element) ，则 Nothing返回 。

readonly firstChild: Word.CustomXmlNode;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取与当前节点的最后一个 CustomXmlNode 子元素对应的 对象。 如果节点没有 (子元素，或者它的类型不是 CustomXmlNodeType.element) ，则 属性返回 Nothing。

readonly lastChild: Word.CustomXmlNode;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取节点命名空间的唯一地址标识符。

readonly namespaceUri: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取当前节点的下一个同级节点（元素、注释或处理指令）。 如果节点是其级别的最后一个同级节点，则 属性返回 Nothing。

readonly nextSibling: Word.CustomXmlNode;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取当前节点的类型。

readonly nodeType: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定当前节点的值。

nodeValue: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取代表与此节点关联的部件的对象。

readonly ownerPart: Word.CustomXmlPart;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取当前节点的父元素节点。 如果当前节点位于根级别，则 属性返回 Nothing。

readonly parentNode: Word.CustomXmlNode;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取当前节点的前一个同级节点（元素、注释或处理指令）。 如果当前节点是其级别的第一个同级节点，则 属性返回 Nothing。

readonly previousSibling: Word.CustomXmlNode;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定当前节点的文本。

text: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取当前节点及其子节点的 XML 表示形式。

readonly xml: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取包含当前节点的规范化 XPath 的字符串。 如果该节点已不在文档对象模型 (DOM) 中，则该属性将返回一条错误消息。

readonly xpath: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

将单个节点作为树中上下文元素节点下的最后一个子节点追加。

appendChildNode(options?: Word.CustomXmlAppendChildNodeOptions): OfficeExtension.ClientResult<number>;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将子树作为树中上下文元素节点下的最后一个子节点添加。

appendChildSubtree(xml: string): OfficeExtension.ClientResult<number>;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

从树中删除当前节点（包括其所有子项，如果有）。

delete(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

指定当前元素节点是否具有子元素节点。

hasChildNodes(): OfficeExtension.ClientResult<boolean>;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

在树中的上下文节点前面插入新节点。

insertNodeBefore(options?: Word.CustomXmlInsertNodeBeforeOptions): OfficeExtension.ClientResult<number>;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将指定的子树插入上下文节点正前的位置。

insertSubtreeBefore(xml: string, options?: Word.CustomXmlInsertSubtreeBeforeOptions): OfficeExtension.ClientResult<number>;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

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

load(options?: Word.Interfaces.CustomXmlNodeLoadOptions): Word.CustomXmlNode;

参数

返回

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

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

参数

返回

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

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

参数

返回

从树中删除指定的子节点。

removeChild(child: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

删除指定的子节点，并将其替换为同一位置中的其他节点。

replaceChildNode(oldNode: Word.CustomXmlNode, options?: Word.CustomXmlReplaceChildNodeOptions): OfficeExtension.ClientResult<number>;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

删除指定的节点，并将其替换为同一位置中的不同子树。

replaceChildSubtree(xml: string, oldNode: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

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

selectNodes(xPath: string): Word.CustomXmlNodeCollection;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

从与 XPath 表达式匹配的集合中选择一个节点。

selectSingleNode(xPath: string): Word.CustomXmlNode;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

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

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

参数

返回

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

set(properties: Word.CustomXmlNode): void;

参数

返回

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

toJSON(): Word.Interfaces.CustomXmlNodeData;

返回

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

track(): Word.CustomXmlNode;

返回

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

untrack(): Word.CustomXmlNode;

返回