Class Element

元素

XML Element 節點的表示法。 

// Adds up the values listed in a sample XML document and adds a new element with the total.
var xml = '<things>'
    + '<plates>12</plates>'
    + '<bowls>18</bowls>'
    + '<cups>25</cups>'
    + '</things>';
var document = XmlService.parse(xml);
var root = document.getRootElement();
var items = root.getChildren();
var total = 0;
for (var i = 0; i < items.length; i++) {
  total += Number(items[i].getText());
}
var 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 節點直系子項的所有 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」中。

參數

名稱類型說明
contentContent要附加的節點

回攻員

Element：用於鏈結的 Element 節點

addContent(index, content)

在指定的索引插入指定節點，位於 Element 個節點。content 引數可以是 Element 物件，也可以是 與 ContentType 中列出的類型相對應的節點物件。

參數

名稱類型說明
indexInteger要在所有直屬子項的節點中插入節點的索引 (共 Element 個節點)
contentContent要插入的節點

回攻員

Element：用於鏈結的 Element 節點

cloneContent()

為所有屬於 {@code Element} 節點子項的所有節點建立未連接的副本。

回攻員

Content[] — 所有節點的未連接副本陣列，這些副本是 {@code Element} 節點

detach()

將節點從父項 Element 節點卸離。如果節點沒有父項 此方法不會有任何效果

回攻員

Content：卸離的節點

getAllContent()

取得屬於 {@code Element} 節點直屬子項的所有節點。

回攻員

Content[]：所有節點的陣列，這些節點都是 {@code Element} 節點的直系子項

getAttribute(name)

取得這個 Element 節點的屬性 (具有指定名稱)，且不含命名空間。如果有 不是這類屬性，這個方法會傳回 null。

參數

名稱類型說明
nameString屬性名稱

回攻員

Attribute：屬性；如果沒有指定名稱的屬性，則傳回 null 命名空間

getAttribute(name, namespace)

取得這個 Element 節點的屬性，其中包含指定的名稱和命名空間。如果有 沒有這類節點，這個方法會傳回 null。

參數

名稱類型說明
nameString屬性名稱
namespaceNamespace屬性的命名空間

回攻員

Attribute：屬性或 null (如果沒有具有指定名稱的屬性，且 命名空間

getAttributes()

取得這個 Element 節點的所有屬性，屬性在文件中顯示的順序。

回攻員

Attribute[]：這個 Element 節點所有屬性的陣列

getChild(name)

取得第一個Element具有指定名稱且沒有立即可用的命名空間 此 Element 節點的子項。如果沒有這類節點，這個方法會傳回 null。

參數

名稱類型說明
nameString子項 Element 節點的名稱

回攻員

Element：Element 節點；如果沒有具有指定名稱且沒有命名空間的直接子項 Element 節點，則為 null

getChild(name, namespace)

取得第一個具有指定名稱和命名空間的 Element 節點，但會立即 此 Element 節點的子項。如果沒有這類節點，這個方法會傳回 null。

參數

名稱類型說明
nameString子項 Element 節點的名稱
namespaceNamespace子項 Element 節點的命名空間

回攻員

Element：Element 節點，或 null (如果沒有具有指定名稱和命名空間的直接子項 Element 節點)

getChildText(name)

取得具有指定名稱且不含命名空間的節點文字值 (如果節點是 Element 節點的即時子項。如果沒有這類節點，此方法會傳回 null。

參數

名稱類型說明
nameString子節點的名稱

回攻員

String：子節點的文字值；如果沒有直接子節點，則為 null 含有特定名稱且不含命名空間

getChildText(name, namespace)

取得具有指定名稱和命名空間的節點文字值 (如果節點為即時節點) Element 節點的子項。如果沒有這類節點，這個方法會傳回 null。

參數

名稱類型說明
nameString子節點的名稱
namespaceNamespace也就是子節點的命名空間

回攻員

String：子節點的文字值；如果沒有直接子節點，則為 null 與指定的命名空間

getChildren()

取得位於 Element 節點中此 Element 節點直系子項的所有 Element 節點 排列順序。

回攻員

Element[] — 所有 Element 節點的陣列，這些節點是此 Element 節點的直系子項

getChildren(name)

取得具有指定名稱且不含直系子項的所有 Element 節點 這個 Element 節點，依照在文件中顯示的順序。

參數

名稱類型說明
nameString子項 Element 節點的名稱

回攻員

Element[] — 所有 Element 節點的陣列，這些節點包含特定名稱，且不含 這個 Element 節點的直接子項

getChildren(name, namespace)

取得所有具備指定名稱和命名空間，且該命名空間為直接子項的 Element 節點 這個 Element 節點，依照在文件中顯示的順序。

參數

名稱類型說明
nameString子項 Element 節點的名稱
namespaceNamespace子項 Element 節點的命名空間

回攻員

Element[] — 所有 Element 節點的陣列，包含特定名稱和命名空間 這個 Element 節點的直接子項

getContent(index)

取得位於指定索引的節點，位於 {@code Element} 節點。如果指定的索引沒有任何節點，此方法會傳回 null。

參數

名稱類型說明
indexInteger納入所有屬於 {@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 節點命名空間。

參數

名稱類型說明
prefixString命名空間的前置字串

回攻員

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 節點的直接或間接父項。

參數

名稱類型說明
otherElement另一個 Element 節點

回攻員

Boolean：如果這個 Element 節點是指定值的直接或間接父項，則為 true Element 節點；如果不是，則為 false

isRootElement()

判斷 Element 節點是否為文件的根節點。

回攻員

Boolean - 如果 Element 節點是文件的根節點，則為 true；如果符合條件，則設為 false 非

removeAttribute(attribute)

移除這個 Element 節點的指定屬性 (如有這類屬性)。

參數

名稱類型說明
attributeAttribute屬性

回攻員

Boolean - true (如果屬性存在並移除)如果不需要，則設為false

removeAttribute(attributeName)

移除這個具有指定名稱且不含命名空間的屬性 (如果有的話) 的 Element 節點屬性 這類屬性確實存在

參數

名稱類型說明
attributeNameString屬性名稱

回攻員

Boolean - true (如果屬性存在並移除)如果不需要，則設為false

removeAttribute(attributeName, namespace)

移除具有特定名稱和命名空間之這個 Element 節點的屬性 (如果有的話) 屬性已存在。

參數

名稱類型說明
attributeNameString屬性名稱
namespaceNamespace屬性的命名空間

回攻員

Boolean - true (如果屬性存在並移除)如果不需要，則設為false

removeContent()

移除 {@code Element} 節點中直屬子項的所有節點。

回攻員

Content[]：所有節點的陣列，這些節點都是 {@code Element} 節點的直系子項 已移除

removeContent(content)

如果節點是 {@code Element} 節點的直屬子項，則移除指定節點。content 引數可以是 Element 物件，也可以是與 ContentType 列出的類型。

參數

名稱類型說明
contentContent要移除的節點

回攻員

Boolean — true 表示節點是立即子項且已移除。如果不需要，則設為false

removeContent(index)

從指定索引的所有節點中移除 {@code Element} 節點。如果指定的索引沒有任何節點，此方法會傳回 null。

參數

名稱類型說明
indexInteger納入所有屬於 {@code Element} 節點

回攻員

Content：已移除的節點；如果指定索引沒有節點，則傳回 null

setAttribute(attribute)

設定這個 Element 節點的指定屬性。

參數

名稱類型說明
attributeAttribute要設定的屬性

回攻員

Element：用於鏈結的 Element 節點

setAttribute(name, value)

使用特定名稱、值、無命名空間來設定這個 Element 節點的屬性。

參數

名稱類型說明
nameString要設定的屬性名稱
valueString待設定的屬性值

回攻員

Element：用於鏈結的 Element 節點

setAttribute(name, value, namespace)

使用指定名稱、值和命名空間設定這個 Element 節點的屬性。

參數

名稱類型說明
nameString要設定的屬性名稱
valueString待設定的屬性值
namespaceNamespace待設定屬性的命名空間

回攻員

Element：用於鏈結的 Element 節點

setName(name)

設定 Element 節點的本機名稱。如要為節點設定命名空間前置字串，請使用 可將 setNamespace(namespace) 與 XmlService.getNamespace(prefix, uri) 搭配使用。

參數

名稱類型說明
nameString要設定的本機名稱

回攻員

Element：用於鏈結的 Element 節點

setNamespace(namespace)

設定 Element 節點的命名空間。

參數

名稱類型說明
namespaceNamespace要設定的命名空間

回攻員

Element：用於鏈結的 Element 節點

setText(text)

設定 Element 節點的文字值。如果節點已包含文字值或 任何子節點，這個方法會覆寫舊內容。如要改為附加或插入內容， 使用 addContent(content) 或 addContent(index, content)。

參數

名稱類型說明
textString要設定的文字

回攻員

Element：用於鏈結的 Element 節點