Word.XmlNode class

表示应用于文档的单个 XML 节点。

注解

使用方

Word.文档： selectSingleNode
Word.XmlNodeCollection： getItem， getItemAt， items

属性

attributes	获取此 XML 节点的属性。如果节点类型为 `attribute`，则返回 `null` 。
baseName	获取不带任何前缀的元素的名称。
childNodes	获取此 XML 节点的子元素。如果节点类型为 `attribute`，则返回空集合。
context	与对象关联的请求上下文。这将加载项的进程连接到 Office 主机应用程序的进程。
firstChild	如果这是父节点，则获取第一个子节点。如果节点类型为 `attribute`，则返回 `null` 。
hasChildNodes	获取此 XML 节点是否有子节点。始终返回 `false` 属性节点，因为它们不能有子节点。
lastChild	如果这是父节点，则获取最后一个子节点。如果节点类型为 `attribute`，则返回 `null` 。
level	获取此 XML 元素是段落的一部分、是段落，还是包含在表格单元格内或包含表格行。如果节点类型为 `attribute`，则返回 `null` 。
namespaceUri	获取此 XML 节点的架构命名空间的统一资源标识符 (URI) 。
nextSibling	获取文档中与此 XML 节点处于同一级别的下一个元素。如果节点类型为 `attribute`，则返回 `null` 。
ownerDocument	获取此 XML 节点的父文档。
parentNode	获取此 XML 节点的父元素。
placeholderText	指定此元素不包含文本时为其显示的文本。仅适用于元素节点，不适用于属性节点。
previousSibling	获取文档中与此 XML 节点处于同一级别的前一个元素。如果节点类型为 `attribute`，则返回 `null` 。
range	获取此 XML 节点中包含的文档部分。如果节点类型为 `attribute`，则返回 `null` 。
text	指定 XML 元素中包含的文本。如果节点类型 `attribute`为，则返回空字符串。
type	获取节点的类型。
validationErrorText	获取此 `XmlNode` 对象的验证错误的说明。对于属性节点可能没有意义。
validationStatus	根据附加的架构获取此元素是否有效。对于属性节点可能没有意义。
value	指定此 XML 节点的值。对于元素节点，表示文本内容;对于属性节点，表示属性值。

方法

copy()	将此 XML 节点（不包括 XML 标记）复制到剪贴板。对于属性节点，仅将属性值复制为文本。
cut()	从文档中删除此 XML 节点并将其置于剪贴板中。对于属性节点，从其父元素中删除属性，并仅将属性值作为文本复制到剪贴板。
delete()	从 XML 文档中删除 XML 节点。对于元素节点，删除整个元素及其内容;对于属性节点，从其父元素中删除属性。
load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
removeChild(childElement)	从此 XML 节点中删除子元素。如果节点类型为 `attribute` (，则此方法无效，因为属性节点没有) 子元素。
selectNodes(xPath, options)	返回与 XPath 参数匹配的所有子元素（按照它们在此 XML 节点中出现的顺序）。如果节点类型为 `attribute` (则返回`null`，因为属性节点没有要搜索) 的子元素。
selectSingleNode(xPath, options)	返回与此 XML 节点中的 XPath 参数匹配的第一个子元素。如果节点类型为 `attribute` (则返回`null`，因为属性节点没有要搜索) 的子元素。
setValidationError(status, options)	更改为此 XML 节点向用户显示的验证错误文本，以及是否强制 Word 将节点报告为无效。对于属性节点可能没有意义。
setValidationError(status, options)	更改为此 XML 节点向用户显示的验证错误文本，以及是否强制 Word 将节点报告为无效。对于属性节点可能没有意义。
toJSON()	覆盖 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 (`JSON.stringify`反过来调用 `toJSON` 传递给它的对象的方法。) 虽然原始 `Word.XmlNode` 对象是 API 对象， `toJSON` 但该方法返回一个纯 JavaScript 对象， (类型化为 `Word.Interfaces.XmlNodeData`) ，其中包含从原始对象加载的任何子属性的浅层副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果在调用中 `.sync` 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。如果此对象是集合的一部分，您还应跟踪父集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。需要在内存释放生效之前调用 `context.sync()` 。
validate()	根据附加到文档的 XML 架构验证此 XML 节点。对于属性节点可能没有意义。

attributes

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

readonly attributes: Word.XmlNodeCollection;

属性值

Word.XmlNodeCollection

注解

API 集：WordApiDesktop 1.4

baseName

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

readonly baseName: string;

属性值

string

注解

API 集：WordApiDesktop 1.4

childNodes

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

readonly childNodes: Word.XmlNodeCollection;

属性值

Word.XmlNodeCollection

注解

API 集：WordApiDesktop 1.4

context

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

context: RequestContext;

属性值

Word.RequestContext

firstChild

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

readonly firstChild: Word.XmlNode;

属性值

Word.XmlNode

注解

API 集：WordApiDesktop 1.4

hasChildNodes

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

readonly hasChildNodes: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

lastChild

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

readonly lastChild: Word.XmlNode;

属性值

Word.XmlNode

注解

API 集：WordApiDesktop 1.4

level

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

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

属性值

Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell"

注解

API 集：WordApiDesktop 1.4

namespaceUri

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

readonly namespaceUri: string;

属性值

string

注解

API 集：WordApiDesktop 1.4

nextSibling

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

readonly nextSibling: Word.XmlNode;

属性值

Word.XmlNode

注解

API 集：WordApiDesktop 1.4

ownerDocument

获取此 XML 节点的父文档。

readonly ownerDocument: Word.Document;

属性值

Word.Document

注解

API 集：WordApiDesktop 1.4

parentNode

获取此 XML 节点的父元素。

readonly parentNode: Word.XmlNode;

属性值

Word.XmlNode

注解

API 集：WordApiDesktop 1.4

placeholderText

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

placeholderText: string;

属性值

string

注解

API 集：WordApiDesktop 1.4

previousSibling

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

readonly previousSibling: Word.XmlNode;

属性值

Word.XmlNode

注解

API 集：WordApiDesktop 1.4

range

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

readonly range: Word.Range;

属性值

Word.Range

注解

API 集：WordApiDesktop 1.4

text

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

text: string;

属性值

string

注解

API 集：WordApiDesktop 1.4

type

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

获取节点的类型。

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

属性值

Word.XmlNodeType | "Element" | "Attribute"

注解

API 集：WordApi BETA (仅预览版)

validationErrorText

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

readonly validationErrorText: string;

属性值

string

注解

API 集：WordApiDesktop 1.4

validationStatus

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

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

属性值

Word.XmlValidationStatus | "Ok" | "Custom"

注解

API 集：WordApiDesktop 1.4

value

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

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

value: string;

属性值

string

注解

API 集：WordApi BETA (仅预览版)

copy()

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

copy(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

cut()

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

cut(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

delete()

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

delete(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

load(options)

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

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

参数

options: Word.Interfaces.XmlNodeLoadOptions

为要加载的对象属性提供选项。

返回

Word.XmlNode

load(propertyNames)

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

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

参数

propertyNames: string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

返回

Word.XmlNode

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

Word.XmlNode

removeChild(childElement)

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

removeChild(childElement: Word.XmlNode): void;

参数

childElement: Word.XmlNode

要删除的子元素。

返回

void

注解

API 集：WordApiDesktop 1.4

selectNodes(xPath, options)

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

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

参数

xPath: string

要计算的 XPath 表达式。

options: Word.SelectNodesOptions

可选。 XPath 搜索的配置选项。

返回

Word.XmlNodeCollection

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

注解

API 集：WordApiDesktop 1.4

selectSingleNode(xPath, options)

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

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

参数

xPath: string

要计算的 XPath 表达式。

options: Word.SelectSingleNodeOptions

可选。 XPath 搜索的配置选项。

返回

Word.XmlNode

与 XPath 表达式匹配的第一个 XML 节点，或者 null 找不到匹配项。

注解

API 集：WordApiDesktop 1.4

setValidationError(status, options)

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

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

参数

status: Word.XmlValidationStatus

要设置的验证状态。

options: Word.XmlNodeSetValidationErrorOptions

可选。用于设置验证错误的配置选项。

返回

void

注解

API 集：WordApiDesktop 1.4

setValidationError(status, options)

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

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

参数

status: "Ok" | "Custom"

要设置的验证状态。

options: Word.XmlNodeSetValidationErrorOptions

可选。用于设置验证错误的配置选项。

返回

void

注解

API 集：WordApiDesktop 1.4

toJSON()

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

toJSON(): Word.Interfaces.XmlNodeData;

返回

Word.Interfaces.XmlNodeData

track()

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

track(): Word.XmlNode;

返回

Word.XmlNode

untrack()

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

untrack(): Word.XmlNode;

返回

Word.XmlNode

validate()

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

validate(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

注解

使用方

属性

方法

属性详细信息

attributes

属性值

注解

baseName

属性值

注解

childNodes

属性值

注解

context

属性值

firstChild

属性值

注解

hasChildNodes

属性值

注解

lastChild

属性值

注解

level

属性值

注解

namespaceUri

属性值

注解

nextSibling

属性值

注解

ownerDocument

属性值

注解

parentNode

属性值

注解

placeholderText

属性值

注解

previousSibling

属性值

注解

range

属性值

注解

text

属性值

注解

type

属性值

注解

validationErrorText

属性值

注解

validationStatus

属性值

注解

value

属性值

注解

方法详细信息

copy()

返回

注解

cut()

返回

注解

delete()

返回

注解

load(options)

参数

返回

load(propertyNames)

参数