本頁面由 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`	以 `[namespacePrefix]:[localName]` 格式，取得 `Element` 節點的本機名稱和命名空間前置字元。
`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()`

以 [namespacePrefix]:[localName] 格式，取得 Element 節點的本機名稱和命名空間前置字元。如果節點沒有命名空間前置字串，請使用 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 節點