Word.CustomXmlNode class
表示文档中树中的 XML 节点。 对象CustomXmlNode是 Word 的成员。CustomXmlNodeCollection 对象。
注解
使用方
- Word.CustomXmlAddNodeOptions： nextSibling
- Word.CustomXmlInsertNodeBeforeOptions： nextSibling
- Word.CustomXmlInsertSubtreeBeforeOptions： nextSibling
- Word.CustomXmlNodeCollection： getItem， items
- Word.CustomXmlPart： addNode、documentElement、selectSingleNode
- Word.CustomXmlValidationError： node
- Word.CustomXmlValidationErrorCollection： add
- Word.文档：selectLinkedControls
- Word.XmlMapping： customXmlNode， setMappingByNode
属性
| attributes | 获取表示 |
| base |
获取不带命名空间前缀的节点的基名称（如有）。 |
| child |
获取包含 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| first |
获取与 |
| last |
获取与当前节点的最后一个子元素对应的 |
| namespace |
获取节点命名空间的唯一地址标识符。 |
| next |
获取当前节点的下一个同级节点（元素、注释或处理指令）。 如果节点是其级别的最后一个同级，则该属性返回 |
| node |
获取当前节点的类型。 |
| node |
指定当前节点的值。 |
| owner |
获取代表与此节点关联的部件的对象。 |
| parent |
获取当前节点的父元素节点。 如果当前节点位于根级别，则该属性返回 |
| previous |
获取当前节点的前一个同级节点（元素、注释或处理指令）。 如果当前节点是其级别上的第一个同级，则该属性返回 |
| text | 指定当前节点的文本。 |
| xml | 获取当前节点及其子节点的 XML 表示形式。 |
| xpath | 获取包含当前节点的标准化 XPath 的字符串。 如果该节点已不在文档对象模型 (DOM) 中，则该属性将返回一条错误消息。 |
方法
| append |
将单个节点作为树中上下文元素节点下的最后一个子节点追加。 |
| append |
将子树作为树中上下文元素节点下的最后一个子节点添加。 |
| delete() | 从树中删除当前节点（包括其所有子项，如果有）。 |
| has |
指定当前元素节点是否具有子元素节点。 |
| insert |
在树中的上下文节点前面插入新节点。 |
| insert |
将指定的子树插入到上下文节点前面的位置。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| remove |
从树中删除指定的子节点。 |
| replace |
删除指定的子节点，并将其替换为同一位置中的不同节点。 |
| replace |
删除指定的节点，并将其替换为同一位置中的不同子树。 |
| select |
选择与 XPath 表达式匹配的节点的集合。 |
| select |
从与 XPath 表达式匹配的集合中选择一个节点。 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
attributes
获取表示 CustomXmlNodeCollection 当前节点中当前元素属性的对象。
readonly attributes: Word.CustomXmlNodeCollection;属性值
注解
baseName
childNodes
获取包含 CustomXmlNodeCollection 当前节点所有子元素的对象。
readonly childNodes: Word.CustomXmlNodeCollection;属性值
注解
context
firstChild
获取与 CustomXmlNode 当前节点的第一个子元素对应的对象。 如果节点没有子元素 (或者它不是 CustomXmlNodeType.element) 类型，则返回 Nothing。
readonly firstChild: Word.CustomXmlNode;属性值
注解
lastChild
获取与当前节点的最后一个子元素对应的 CustomXmlNode 对象。 如果节点 (没有子元素，或者它不是 CustomXmlNodeType.element) 类型，则该属性返回 Nothing。
readonly lastChild: Word.CustomXmlNode;属性值
注解
namespaceUri
nextSibling
获取当前节点的下一个同级节点（元素、注释或处理指令）。 如果节点是其级别的最后一个同级，则该属性返回 Nothing。
readonly nextSibling: Word.CustomXmlNode;属性值
注解
nodeType
获取当前节点的类型。
readonly nodeType: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document";属性值
Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"
注解
nodeValue
ownerPart
获取代表与此节点关联的部件的对象。
readonly ownerPart: Word.CustomXmlPart;属性值
注解
parentNode
获取当前节点的父元素节点。 如果当前节点位于根级别，则该属性返回 Nothing。
readonly parentNode: Word.CustomXmlNode;属性值
注解
previousSibling
获取当前节点的前一个同级节点（元素、注释或处理指令）。 如果当前节点是其级别上的第一个同级，则该属性返回 Nothing。
readonly previousSibling: Word.CustomXmlNode;属性值
注解
text
xml
xpath
获取包含当前节点的标准化 XPath 的字符串。 如果该节点已不在文档对象模型 (DOM) 中，则该属性将返回一条错误消息。
readonly xpath: string;属性值
string
注解
方法详细信息
appendChildNode(options)
将单个节点作为树中上下文元素节点下的最后一个子节点追加。
appendChildNode(options?: Word.CustomXmlAppendChildNodeOptions): OfficeExtension.ClientResult<number>;参数
可选。 定义要追加节点的选项。
返回
OfficeExtension.ClientResult<number>
注解
appendChildSubtree(xml)
将子树作为树中上下文元素节点下的最后一个子节点添加。
appendChildSubtree(xml: string): OfficeExtension.ClientResult<number>;参数
- xml
-
string
表示 XML 子树的字符串。
返回
OfficeExtension.ClientResult<number>
注解
delete()
hasChildNodes()
指定当前元素节点是否具有子元素节点。
hasChildNodes(): OfficeExtension.ClientResult<boolean>;返回
OfficeExtension.ClientResult<boolean>
注解
insertNodeBefore(options)
在树中的上下文节点前面插入新节点。
insertNodeBefore(options?: Word.CustomXmlInsertNodeBeforeOptions): OfficeExtension.ClientResult<number>;参数
可选。 定义要插入的节点的选项。
返回
OfficeExtension.ClientResult<number>
注解
insertSubtreeBefore(xml, options)
将指定的子树插入到上下文节点前面的位置。
insertSubtreeBefore(xml: string, options?: Word.CustomXmlInsertSubtreeBeforeOptions): OfficeExtension.ClientResult<number>;参数
- xml
-
string
表示 XML 子树的字符串。
可选。 可用于插入子树的选项。
返回
OfficeExtension.ClientResult<number>
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.CustomXmlNodeLoadOptions): Word.CustomXmlNode;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.CustomXmlNode;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.CustomXmlNode;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
removeChild(child)
从树中删除指定的子节点。
removeChild(child: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;参数
- child
- Word.CustomXmlNode
要删除的子节点。
返回
OfficeExtension.ClientResult<number>
注解
replaceChildNode(oldNode, options)
删除指定的子节点，并将其替换为同一位置中的不同节点。
replaceChildNode(oldNode: Word.CustomXmlNode, options?: Word.CustomXmlReplaceChildNodeOptions): OfficeExtension.ClientResult<number>;参数
- oldNode
- Word.CustomXmlNode
要替换的节点。
可选。 定义要替换旧节点的子节点的选项。
返回
OfficeExtension.ClientResult<number>
注解
replaceChildSubtree(xml, oldNode)
删除指定的节点，并将其替换为同一位置中的不同子树。
replaceChildSubtree(xml: string, oldNode: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;参数
- xml
-
string
表示新子树的字符串。
- oldNode
- Word.CustomXmlNode
要替换的节点。
返回
OfficeExtension.ClientResult<number>
注解
selectNodes(xPath)
选择与 XPath 表达式匹配的节点的集合。
selectNodes(xPath: string): Word.CustomXmlNodeCollection;参数
- xPath
-
string
XPath 表达式。
返回
注解
selectSingleNode(xPath)
从与 XPath 表达式匹配的集合中选择一个节点。
selectSingleNode(xPath: string): Word.CustomXmlNode;参数
- xPath
-
string
XPath 表达式。
返回
注解
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.CustomXmlNodeUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Word.Interfaces.CustomXmlNodeUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
基于现有加载的对象，同时在对象上设置多个属性。
set(properties: Word.CustomXmlNode): void;参数
- properties
- Word.CustomXmlNode
返回
void
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.CustomXmlNode 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.CustomXmlNodeData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Word.Interfaces.CustomXmlNodeData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。
track(): Word.CustomXmlNode;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): Word.CustomXmlNode;