此页面由 Cloud Translation API 翻译。

Class Element

XML Element 节点的表示形式。

// Adds up the values listed in a sample XML document and adds a new element
// with the total.
let xml = '<things>' +
    '<plates>12</plates>' +
    '<bowls>18</bowls>' +
    '<cups>25</cups>' +
    '</things>';
const document = XmlService.parse(xml);
const root = document.getRootElement();
const items = root.getChildren();
let total = 0;
for (let i = 0; i < items.length; i++) {
  total += Number(items[i].getText());
}
const totalElement = XmlService.createElement('total').setText(total);
root.addContent(totalElement);
xml = XmlService.getPrettyFormat().format(document);
Logger.log(xml);

方法

方法	返回类型	简介
`addContent(content)`	`Element`	将指定节点附加为 `Element` 节点的最后一个子节点。
`addContent(index, content)`	`Element`	在 `Element` 节点的所有直接子节点中，将给定节点插入给定索引。
`cloneContent()`	`Content[]`	为 {@code Element} 节点的所有直接子节点创建未附加的副本。
`detach()`	`Content`	将节点从其父级 `Element` 节点分离。
`getAllContent()`	`Content[]`	获取 {@code Element} 节点的所有直接子节点。
`getAttribute(name)`	`Attribute`	获取具有给定名称且无命名空间的此 `Element` 节点的属性。
`getAttribute(name, namespace)`	`Attribute`	获取具有给定名称和命名空间的此 `Element` 节点的属性。
`getAttributes()`	`Attribute[]`	按文档中显示的顺序获取此 `Element` 节点的所有属性。
`getChild(name)`	`Element`	获取具有给定名称且没有命名空间且是此 `Element` 节点的直接子项的第一个 `Element` 节点。
`getChild(name, namespace)`	`Element`	获取具有给定名称和命名空间且是此 `Element` 节点的直接子项的第一个 `Element` 节点。
`getChildText(name)`	`String`	如果节点是 `Element` 节点的直接子节点，则获取具有给定名称且没有命名空间的节点的文本值。
`getChildText(name, namespace)`	`String`	如果节点是 `Element` 节点的直接子节点，则获取具有给定名称和命名空间的节点的文本值。
`getChildren()`	`Element[]`	获取此 `Element` 节点的所有直接子 `Element` 节点，按文档中显示的顺序。
`getChildren(name)`	`Element[]`	获取具有给定名称且没有命名空间且是此 `Element` 节点的直接子级的所有 `Element` 节点，按文档中显示的顺序。
`getChildren(name, namespace)`	`Element[]`	获取具有给定名称和命名空间且是此 `Element` 节点的直接子级的所有 `Element` 节点，按文档中显示的顺序。
`getContent(index)`	`Content`	从 {@code Element} 节点的所有直接子节点中获取给定索引对应的节点。
`getContentSize()`	`Integer`	获取 {@code Element} 节点的直接子节点的数量。
`getDescendants()`	`Content[]`	按文档中显示的顺序获取 {@code Element} 节点的直接或间接子节点的所有节点。
`getDocument()`	`Document`	获取包含 {@code Element} 节点的 XML 文档。
`getName()`	`String`	获取 `Element` 节点的本地名称。
`getNamespace()`	`Namespace`	获取 `Element` 节点的命名空间。
`getNamespace(prefix)`	`Namespace`	获取具有给定前缀的 `Element` 节点命名空间。
`getParentElement()`	`Element`	获取节点的父 `Element` 节点。
`getQualifiedName()`	`String`	获取 `Element` 节点的本地名称和命名空间前缀，格式为 `[namespacePrefix]:[localName]`。
`getText()`	`String`	获取 `Element` 节点的文本值。
`getValue()`	`String`	获取节点的直接或间接子节点的所有文本值，按文档中显示的顺序。
`isAncestorOf(other)`	`Boolean`	确定此 `Element` 节点是给定 `Element` 节点的直接父级还是间接父级。
`isRootElement()`	`Boolean`	确定 `Element` 节点是否为文档的根节点。
`removeAttribute(attribute)`	`Boolean`	移除此 `Element` 节点的指定属性（如果存在）。
`removeAttribute(attributeName)`	`Boolean`	移除此 `Element` 节点具有给定名称且没有命名空间的属性（如果存在）。
`removeAttribute(attributeName, namespace)`	`Boolean`	移除此 `Element` 节点具有给定名称和命名空间的属性（如果存在）。
`removeContent()`	`Content[]`	移除 {@code Element} 节点的所有直接子节点。
`removeContent(content)`	`Boolean`	如果给定节点是 {@code Element} 节点的直接子节点，则移除该节点。
`removeContent(index)`	`Content`	从 {@code Element} 节点的所有直接子节点中移除指定编号的节点。
`setAttribute(attribute)`	`Element`	为此 `Element` 节点设置给定属性。
`setAttribute(name, value)`	`Element`	使用给定名称、值和无命名空间为此 `Element` 节点设置属性。
`setAttribute(name, value, namespace)`	`Element`	使用给定的名称、值和命名空间为此 `Element` 节点设置属性。
`setName(name)`	`Element`	设置 `Element` 节点的本地名称。
`setNamespace(namespace)`	`Element`	设置 `Element` 节点的命名空间。
`setText(text)`	`Element`	设置 `Element` 节点的文本值。

详细文档

`addContent(content)`

将给定节点附加为 Element 节点的最后一个子节点。content 参数可以是 Element 对象，也可以是与 ContentType 中列出的类型对应的任何节点对象。

参数

名称	类型	说明
`content`	`Content`	要附加的节点

Element - Element 节点，用于链式调用

`addContent(index, content)`

在 Element 节点的所有直接子节点中，将给定节点插入给定索引。content 参数可以是 Element 对象，也可以是与 ContentType 中列出的类型对应的任何节点对象。

参数

名称	类型	说明
`index`	`Integer`	要在 `Element` 节点的所有直接子节点中插入节点的位置索引
`content`	`Content`	要插入的节点

Element - Element 节点，用于链式调用

`cloneContent()`

为 {@code Element} 节点的所有直接子节点创建未附加的副本。

Content[] - 所有作为 {@code Element} 节点的直接子节点的未附加副本的数组

`detach()`

将节点从其父级 Element 节点分离。如果节点没有父节点，此方法将无效。

Content - 分离的节点

`getAllContent()`

获取 {@code Element} 节点的所有直接子节点。

Content[] - 包含 {@code Element} 节点的直接子节点的所有节点的数组

`getAttribute(name)`

获取具有给定名称且无命名空间的此 Element 节点的属性。如果没有此类属性，此方法会返回 null。

参数

名称	类型	说明
`name`	`String`	属性的名称

Attribute - 属性；如果没有具有给定名称且没有命名空间的属性，则为 null

`getAttribute(name, namespace)`

获取具有给定名称和命名空间的此 Element 节点的属性。如果没有此类节点，此方法会返回 null。

参数

名称	类型	说明
`name`	`String`	属性的名称
`namespace`	`Namespace`	属性的命名空间

Attribute - 属性；如果没有具有给定名称和命名空间的属性，则为 null

`getAttributes()`

按文档中显示的顺序获取此 Element 节点的所有属性。

Attribute[] - 此 Element 节点的所有属性的数组

`getChild(name)`

获取具有给定名称且没有命名空间且是此 Element 节点的直接子项的第一个 Element 节点。如果没有此类节点，此方法会返回 null。

参数

名称	类型	说明
`name`	`String`	子 `Element` 节点的名称

Element - Element 节点；如果没有具有给定名称且没有命名空间的直接子 Element 节点，则为 null

`getChild(name, namespace)`

获取具有给定名称和命名空间且是此 Element 节点的直接子项的第一个 Element 节点。如果没有此类节点，此方法会返回 null。

参数

名称	类型	说明
`name`	`String`	子 `Element` 节点的名称
`namespace`	`Namespace`	子 `Element` 节点的命名空间

Element - Element 节点；如果没有具有给定名称和命名空间的直接子 Element 节点，则为 null

`getChildText(name)`

如果节点是 Element 节点的直接子节点，则获取具有给定名称且没有命名空间的节点的文本值。如果没有此类节点，此方法会返回 null。

参数

名称	类型	说明
`name`	`String`	子节点的名称

String - 子节点的文本值；如果没有具有给定名称且没有命名空间的直接子节点，则为 null

`getChildText(name, namespace)`

如果节点是 Element 节点的直接子节点，则获取具有给定名称和命名空间的节点的文本值。如果没有此类节点，此方法会返回 null。

参数

名称	类型	说明
`name`	`String`	子节点的名称
`namespace`	`Namespace`	子节点的命名空间

String - 子节点的文本值；如果没有具有给定名称和命名空间的直接子节点，则为 null

`getChildren()`

获取此 Element 节点的所有直接子 Element 节点，按文档中显示的顺序。

Element[] - 此 Element 节点的直接子节点的所有 Element 节点的数组

`getChildren(name)`

获取具有给定名称且没有命名空间且是此 Element 节点的直接子级的所有 Element 节点，按文档中显示的顺序。

参数

名称	类型	说明
`name`	`String`	子 `Element` 节点的名称

Element[] - 此 Element 节点的直接子节点中具有给定名称且没有命名的所有 Element 节点的数组

`getChildren(name, namespace)`

获取具有给定名称和命名空间且是此 Element 节点的直接子级的所有 Element 节点，按文档中显示的顺序。

参数

名称	类型	说明
`name`	`String`	子 `Element` 节点的名称
`namespace`	`Namespace`	子 `Element` 节点的命名空间

Element[] - 包含给定名称和命名空间且是此 Element 节点的直接子节点的所有 Element 节点的数组

`getContent(index)`

从 {@code Element} 节点的所有直接子节点中获取给定索引对应的节点。如果指定索引处没有节点，则此方法会返回 null。

参数

名称	类型	说明
`index`	`Integer`	在 {@code Element} 节点的所有直接子节点中，该节点的编号

Content - 节点；如果给定索引没有节点，则为 null

`getContentSize()`

获取 {@code Element} 节点的直接子节点的数量。

Integer - {@code Element} 节点的直接子节点的数量

`getDescendants()`

按文档中显示的顺序获取 {@code Element} 节点的直接或间接子节点的所有节点。

Content[] - 包含 {@code Element} 节点的直接或间接子节点的所有节点的数组

`getDocument()`

获取包含 {@code Element} 节点的 XML 文档。

Document - 包含 {@code Element} 节点的文档

`getName()`

获取 Element 节点的本地名称。如果节点具有命名空间前缀，请使用 getQualifiedName() 或 getNamespace()。getPrefix() 来获取前缀。

String - Element 节点的本地名称

`getNamespace()`

获取 Element 节点的命名空间。

Namespace - Element 节点的命名空间

`getNamespace(prefix)`

获取具有给定前缀的 Element 节点命名空间。

参数

名称	类型	说明
`prefix`	`String`	命名空间的前缀

Namespace - 具有 Element 节点给定前缀的命名空间

`getParentElement()`

获取节点的父 Element 节点。如果节点没有父节点，此方法会返回 null。

Element - 父 Element 节点

`getQualifiedName()`

获取 Element 节点的本地名称和命名空间前缀，格式为 [namespacePrefix]:[localName]。如果节点没有命名空间前缀，请使用 getName()。

String - Element 节点的本地名称和命名空间前缀，格式为 [namespacePrefix]:[localName]

`getText()`

获取 Element 节点的文本值。

String - Element 节点的文本值

`getValue()`

获取节点的直接或间接子节点的所有文本值，按文档中显示的顺序。

String - 节点的直接或间接子节点的所有文本值

`isAncestorOf(other)`

确定此 Element 节点是给定 Element 节点的直接父级还是间接父级。

参数

名称	类型	说明
`other`	`Element`	另一个 `Element` 节点

Boolean - 如果此 Element 节点是给定 Element 节点的直接或间接父级，则为 true；否则为 false

`isRootElement()`

确定 Element 节点是否为文档的根节点。

Boolean - 如果 Element 节点是文档的根节点，则为 true；否则为 false

`removeAttribute(attribute)`

移除此 Element 节点的指定属性（如果存在）。

参数

名称	类型	说明
`attribute`	`Attribute`	属性

Boolean - 如果属性存在且已移除，则为 true；否则为 false

`removeAttribute(attributeName)`

移除此 Element 节点具有给定名称且没有命名空间的属性（如果存在）。

参数

名称	类型	说明
`attributeName`	`String`	属性的名称

Boolean - 如果属性存在且已移除，则为 true；否则为 false

`removeAttribute(attributeName, namespace)`

移除此 Element 节点具有给定名称和命名空间的属性（如果存在）。

参数

名称	类型	说明
`attributeName`	`String`	属性的名称
`namespace`	`Namespace`	属性的命名空间

Boolean - 如果属性存在且已移除，则为 true；否则为 false

`removeContent()`

移除 {@code Element} 节点的所有直接子节点。

Content[] - 在被移除之前是 {@code Element} 节点的直接子节点的所有节点的数组

`removeContent(content)`

如果给定节点是 {@code Element} 节点的直接子节点，则移除该节点。content 参数可以是 Element 对象，也可以是与 ContentType 中列出的类型对应的任何节点对象。

参数

名称	类型	说明
`content`	`Content`	要移除的节点

Boolean - 如果节点是直接子节点且已被移除，则为 true；否则为 false

`removeContent(index)`

从 {@code Element} 节点的所有直接子节点中移除指定编号的节点。如果指定索引处没有节点，则此方法会返回 null。

参数

名称	类型	说明
`index`	`Integer`	在 {@code Element} 节点的所有直接子节点中，该节点的编号

Content - 被移除的节点；如果给定索引处没有节点，则返回 null

`setAttribute(attribute)`

为此 Element 节点设置给定属性。

参数

名称	类型	说明
`attribute`	`Attribute`	要设置的属性

Element - Element 节点，用于链式调用

`setAttribute(name, value)`

使用给定名称、值和无命名空间为此 Element 节点设置属性。

参数

名称	类型	说明
`name`	`String`	要设置的属性的名称
`value`	`String`	要设置的属性的值

Element - Element 节点，用于链式调用

`setAttribute(name, value, namespace)`

使用给定的名称、值和命名空间为此 Element 节点设置属性。

参数

名称	类型	说明
`name`	`String`	要设置的属性的名称
`value`	`String`	要设置的属性的值
`namespace`	`Namespace`	要设置的属性的命名空间

Element - Element 节点，用于链式调用

`setName(name)`

设置 Element 节点的本地名称。如需为节点设置命名空间前缀，请将 setNamespace(namespace) 与 XmlService.getNamespace(prefix, uri) 结合使用。

参数

名称	类型	说明
`name`	`String`	要设置的本地名称

Element - Element 节点，用于链式调用

`setNamespace(namespace)`

设置 Element 节点的命名空间。

参数

名称	类型	说明
`namespace`	`Namespace`	要设置的命名空间

Element - Element 节点，用于链式调用

`setText(text)`

设置 Element 节点的文本值。如果节点已包含文本值或任何子节点，此方法会覆盖旧内容。如需附加或插入内容，请改用 addContent(content) 或 addContent(index, content)。

参数

名称	类型	说明
`text`	`String`	要设置的文本

Element - Element 节点，用于链式调用

Class Element 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

方法

详细文档

addContent(content)

参数

返回

addContent(index, content)

参数

返回

cloneContent()

返回

detach()

返回

getAllContent()

返回

getAttribute(name)

参数

返回

getAttribute(name, namespace)

参数

返回

getAttributes()

返回

getChild(name)

参数

返回

getChild(name, namespace)

参数

返回

getChildText(name)

参数

返回

getChildText(name, namespace)

参数

返回

getChildren()

返回

getChildren(name)

参数

返回

getChildren(name, namespace)

参数

返回

getContent(index)

参数

返回

getContentSize()

返回

getDescendants()

返回

getDocument()

返回

getName()

返回

getNamespace()

返回

getNamespace(prefix)

参数

返回

getParentElement()

返回

getQualifiedName()

返回

getText()

返回

getValue()

返回

isAncestorOf(other)

参数

返回

isRootElement()

返回

removeAttribute(attribute)

参数

返回

removeAttribute(attributeName)

参数

返回

removeAttribute(attributeName, namespace)

参数

Class Element

`addContent(content)`

`addContent(index, content)`

`cloneContent()`

`detach()`

`getAllContent()`

`getAttribute(name)`

`getAttribute(name, namespace)`

`getAttributes()`

`getChild(name)`

`getChild(name, namespace)`

`getChildText(name)`

`getChildText(name, namespace)`

`getChildren()`

`getChildren(name)`

`getChildren(name, namespace)`

`getContent(index)`

`getContentSize()`

`getDescendants()`

`getDocument()`

`getName()`

`getNamespace()`

`getNamespace(prefix)`

`getParentElement()`

`getQualifiedName()`

`getText()`

`getValue()`

`isAncestorOf(other)`

`isRootElement()`

`removeAttribute(attribute)`

`removeAttribute(attributeName)`

`removeAttribute(attributeName, namespace)`

`removeContent()`

`removeContent(content)`

`removeContent(index)`

`setAttribute(attribute)`

`setAttribute(name, value)`

`setAttribute(name, value, namespace)`

`setName(name)`

`setNamespace(namespace)`

`setText(text)`