Class Element

Element

Eine Darstellung eines XML-Element-Knotens.

// 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);

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
addContent(content)	Element	Fügt den angegebenen Knoten als letztes untergeordnetes Element des Element-Knotens an.
addContent(index, content)	Element	Fügt den angegebenen Knoten am angegebenen Index zwischen allen Knoten ein, die direkte untergeordnete Elemente des Element-Knotens sind.
cloneContent()	Content[]	Erstellt nicht angehängte Kopien aller Knoten, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind.
detach()	Content|null	Trennt den Knoten vom übergeordneten Knoten Element.
getAllContent()	Content[]	Ruft alle Knoten ab, die direkte untergeordnete Elemente des {@code Element}-Knotens sind.
getAttribute(name)	Attribute|null	Ruft das Attribut für diesen Element-Knoten mit dem angegebenen Namen und ohne Namespace ab.
getAttribute(name, namespace)	Attribute|null	Ruft das Attribut für diesen Element-Knoten mit dem angegebenen Namen und Namespace ab.
getAttributes()	Attribute[]	Ruft alle Attribute für diesen Element-Knoten in der Reihenfolge ab, in der sie im Dokument angezeigt werden.
getChild(name)	Element|null	Ruft den ersten Element-Knoten mit dem angegebenen Namen und ohne Namespace ab, der ein direktes untergeordnetes Element dieses Element-Knotens ist.
getChild(name, namespace)	Element|null	Ruft den ersten Element-Knoten mit dem angegebenen Namen und Namespace ab, der ein direktes untergeordnetes Element dieses Element-Knotens ist.
getChildText(name)	String|null	Ruft den Textwert des Knotens mit dem angegebenen Namen und ohne Namespace ab, wenn der Knoten ein direktes untergeordnetes Element des Knotens Element ist.
getChildText(name, namespace)	String|null	Ruft den Textwert des Knotens mit dem angegebenen Namen und Namespace ab, wenn der Knoten ein direktes untergeordnetes Element des Knotens Element ist.
getChildren()	Element[]	Ruft alle Element-Knoten ab, die unmittelbare untergeordnete Elemente dieses Element-Knotens sind, in der Reihenfolge, in der sie im Dokument angezeigt werden.
getChildren(name)	Element[]	Ruft alle Element-Knoten mit dem angegebenen Namen und ohne Namespace ab, die unmittelbare untergeordnete Elemente dieses Element-Knotens sind, in der Reihenfolge, in der sie im Dokument angezeigt werden.
getChildren(name, namespace)	Element[]	Ruft alle Element-Knoten mit dem angegebenen Namen und Namespace ab, die unmittelbare untergeordnete Elemente dieses Element-Knotens sind, in der Reihenfolge, in der sie im Dokument vorkommen.
getContent(index)	Content|null	Ruft den Knoten am angegebenen Index unter allen Knoten ab, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind.
getContentSize()	Integer	Gibt die Anzahl der Knoten zurück, die direkte untergeordnete Elemente des {@code Element}-Knotens sind.
getDescendants()	Content[]	Ruft alle Knoten ab, die direkte oder indirekte untergeordnete Elemente des {@code Element}-Knotens sind, in der Reihenfolge, in der sie im Dokument angezeigt werden.
getDocument()	Document	Gibt das XML-Dokument zurück, das den {@code Element}-Knoten enthält.
getName()	String	Ruft den lokalen Namen des Element-Knotens ab.
getNamespace()	Namespace	Ruft den Namespace für den Knoten Element ab.
getNamespace(prefix)	Namespace	Ruft den Namespace mit dem angegebenen Präfix für den Element-Knoten ab.
getParentElement()	Element|null	Ruft den übergeordneten Element-Knoten des Knotens ab.
getQualifiedName()	String	Ruft den lokalen Namen und das Namespace-Präfix des Element-Knotens im Format [namespacePrefix]:[localName] ab.
getText()	String	Ruft den Textwert des Knotens Element ab.
getValue()	String	Ruft den Textwert aller Knoten ab, die direkte oder indirekte untergeordnete Elemente des Knotens sind, in der Reihenfolge, in der sie im Dokument angezeigt werden.
isAncestorOf(other)	Boolean	Gibt an, ob dieser Element-Knoten ein direktes oder indirektes übergeordnetes Element eines bestimmten Element-Knotens ist.
isRootElement()	Boolean	Gibt an, ob der Knoten Element der Stammknoten des Dokuments ist.
removeAttribute(attribute)	Boolean	Entfernt das angegebene Attribut für diesen Element-Knoten, sofern ein solches Attribut vorhanden ist.
removeAttribute(attributeName)	Boolean	Entfernt das Attribut für diesen Element-Knoten mit dem angegebenen Namen und ohne Namespace, falls ein solches Attribut vorhanden ist.
removeAttribute(attributeName, namespace)	Boolean	Entfernt das Attribut für diesen Element-Knoten mit dem angegebenen Namen und Namespace, falls ein solches Attribut vorhanden ist.
removeContent()	Content[]	Entfernt alle Knoten, die direkte untergeordnete Elemente des {@code Element}-Knotens sind.
removeContent(content)	Boolean	Entfernt den angegebenen Knoten, wenn er ein direkt untergeordnetes Element des {@code Element}-Knotens ist.
removeContent(index)	Content|null	Entfernt den Knoten am angegebenen Index unter allen Knoten, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind.
setAttribute(attribute)	Element	Legt das angegebene Attribut für diesen Element-Knoten fest.
setAttribute(name, value)	Element	Legt das Attribut für diesen Element-Knoten mit dem angegebenen Namen und Wert und ohne Namespace fest.
setAttribute(name, value, namespace)	Element	Legt das Attribut für diesen Element-Knoten mit dem angegebenen Namen, Wert und Namespace fest.
setName(name)	Element	Legt den lokalen Namen des Element-Knotens fest.
setNamespace(namespace)	Element	Legt den Namespace für den Knoten Element fest.
setText(text)	Element	Legt den Textwert des Knotens Element fest.

Detaillierte Dokumentation

addContent(content)

Fügt den angegebenen Knoten als letztes untergeordnetes Element des Element-Knotens an. Das content-Argument kann ein Element-Objekt oder ein beliebiges Knotenobjekt sein, das einem in ContentType aufgeführten Typ entspricht.

Parameter

Name	Typ	Beschreibung
content	Content	Der anzuhängende Knoten.

Rückflug

Element: Der Knoten Element zur Verkettung.

---

addContent(index, content)

Fügt den angegebenen Knoten am angegebenen Index zwischen allen Knoten ein, die direkte untergeordnete Elemente des Element-Knotens sind. Das Argument content kann ein Element-Objekt oder ein beliebiges Knotenobjekt sein, das einem in ContentType aufgeführten Typ entspricht.

Parameter

Name	Typ	Beschreibung
index	Integer	Der Index, an dem der Knoten zwischen allen Knoten eingefügt werden soll, die unmittelbare untergeordnete Elemente des Element-Knotens sind.
content	Content	Der einzufügende Knoten.

Rückflug

Element: Der Knoten Element zur Verkettung.

---

cloneContent()

Erstellt nicht angehängte Kopien aller Knoten, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind.

Rückflug

Content[]: Ein Array mit nicht angehängten Kopien aller Knoten, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind.

---

detach()

Trennt den Knoten vom übergeordneten Knoten Element. Wenn der Knoten kein übergeordnetes Element hat, hat diese Methode keine Auswirkungen.

Rückflug

Content|null – Der getrennte Knoten.

---

getAllContent()

Ruft alle Knoten ab, die direkte untergeordnete Elemente des {@code Element}-Knotens sind.

Rückflug

Content[]: Ein Array aller Knoten, die direkte untergeordnete Elemente des {@code Element}-Knotens sind.

---

getAttribute(name)

Ruft das Attribut für diesen Element-Knoten mit dem angegebenen Namen und ohne Namespace ab. Wenn kein solches Attribut vorhanden ist, gibt diese Methode null zurück.

Parameter

Name	Typ	Beschreibung
name	String	Der Name des Attributs.

Rückflug

Attribute|null: Das Attribut oder null, wenn kein Attribut mit dem angegebenen Namen und kein Namespace vorhanden ist.

---

getAttribute(name, namespace)

Ruft das Attribut für diesen Element-Knoten mit dem angegebenen Namen und Namespace ab. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

Name	Typ	Beschreibung
name	String	Der Name des Attributs.
namespace	Namespace	Der Namespace des Attributs.

Rückflug

Attribute|null: Das Attribut oder null, wenn kein Attribut mit dem angegebenen Namen und Namespace vorhanden ist.

---

getAttributes()

Ruft alle Attribute für diesen Element-Knoten in der Reihenfolge ab, in der sie im Dokument angezeigt werden.

Rückflug

Attribute[]: Ein Array aller Attribute für diesen Element-Knoten.

---

getChild(name)

Ruft den ersten Element-Knoten mit dem angegebenen Namen und ohne Namespace ab, der ein direktes untergeordnetes Element dieses Element-Knotens ist. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

Name	Typ	Beschreibung
name	String	Der Name des untergeordneten Element-Knotens.

Rückflug

Element|null: Der Knoten Element oder null, wenn es keinen untergeordneten Knoten Element mit dem angegebenen Namen und keinen Namespace gibt.

---

getChild(name, namespace)

Ruft den ersten Element-Knoten mit dem angegebenen Namen und Namespace ab, der ein direktes untergeordnetes Element dieses Element-Knotens ist. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

Name	Typ	Beschreibung
name	String	Der Name des untergeordneten Element-Knotens.
namespace	Namespace	Der Namespace des untergeordneten Element-Knotens.

Rückflug

Element|null: Der Knoten Element oder null, wenn es keinen unmittelbaren untergeordneten Knoten Element mit dem angegebenen Namen und Namespace gibt.

---

getChildText(name)

Ruft den Textwert des Knotens mit dem angegebenen Namen und ohne Namespace ab, wenn der Knoten ein direktes untergeordnetes Element des Knotens Element ist. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

Name	Typ	Beschreibung
name	String	Der Name des untergeordneten Knotens.

Rückflug

String|null: Der Textwert des untergeordneten Knotens oder null, wenn es keinen direkten untergeordneten Knoten mit dem angegebenen Namen und keinen Namespace gibt.

---

getChildText(name, namespace)

Ruft den Textwert des Knotens mit dem angegebenen Namen und Namespace ab, wenn der Knoten ein direktes untergeordnetes Element des Knotens Element ist. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

Name	Typ	Beschreibung
name	String	Der Name des untergeordneten Knotens.
namespace	Namespace	Der Namespace des untergeordneten Knotens.

Rückflug

String|null: Der Textwert des untergeordneten Knotens oder null, wenn es keinen direkten untergeordneten Knoten mit dem angegebenen Namen und Namespace gibt.

---

getChildren()

Ruft alle Element-Knoten ab, die unmittelbare untergeordnete Elemente dieses Element-Knotens sind, in der Reihenfolge, in der sie im Dokument angezeigt werden.

Rückflug

Element[]: Ein Array aller Element-Knoten, die direkte untergeordnete Elemente dieses Element-Knotens sind.

---

getChildren(name)

Ruft alle Element-Knoten mit dem angegebenen Namen und ohne Namespace ab, die unmittelbare untergeordnete Elemente dieses Element-Knotens sind, in der Reihenfolge, in der sie im Dokument angezeigt werden.

Parameter

Name	Typ	Beschreibung
name	String	Der Name der untergeordneten Element-Knoten.

Rückflug

Element[]: Ein Array aller Element-Knoten mit dem angegebenen Namen und ohne Namespace, die untergeordnete Elemente dieses Element-Knotens sind.

---

getChildren(name, namespace)

Ruft alle Element-Knoten mit dem angegebenen Namen und Namespace ab, die unmittelbare untergeordnete Elemente dieses Element-Knotens sind, in der Reihenfolge, in der sie im Dokument vorkommen.

Parameter

Name	Typ	Beschreibung
name	String	Der Name der untergeordneten Element-Knoten.
namespace	Namespace	Der Namespace der untergeordneten Element-Knoten.

Rückflug

Element[]: Ein Array aller Element-Knoten mit dem angegebenen Namen und Namespace, die untergeordnete Elemente dieses Element-Knotens sind.

---

getContent(index)

Ruft den Knoten am angegebenen Index unter allen Knoten ab, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind. Wenn am angegebenen Index kein Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

Name	Typ	Beschreibung
index	Integer	Der Index für den Knoten unter allen Knoten, die direkte untergeordnete Elemente des {@code Element}-Knotens sind.

Rückflug

Content|null: Der Knoten oder null, wenn am angegebenen Index kein Knoten vorhanden ist.

---

getContentSize()

Gibt die Anzahl der Knoten zurück, die direkte untergeordnete Elemente des {@code Element}-Knotens sind.

Rückflug

Integer: Die Anzahl der Knoten, die direkte untergeordnete Elemente des {@code Element}-Knotens sind.

---

getDescendants()

Ruft alle Knoten ab, die direkte oder indirekte untergeordnete Elemente des {@code Element}-Knotens sind, in der Reihenfolge, in der sie im Dokument angezeigt werden.

Rückflug

Content[]: Ein Array aller Knoten, die direkte oder indirekte untergeordnete Elemente des {@code Element}-Knotens sind.

---

getDocument()

Gibt das XML-Dokument zurück, das den {@code Element}-Knoten enthält.

Rückflug

Document: Das Dokument, das den {@code Element}-Knoten enthält.

---

getName()

Ruft den lokalen Namen des Element-Knotens ab. Wenn der Knoten ein Namespace-Präfix hat, verwenden Sie getQualifiedName() oder getNamespace().getPrefix(), um das Präfix zu erhalten.

Rückflug

String: Der lokale Name des Element-Knotens.

---

getNamespace()

Ruft den Namespace für den Knoten Element ab.

Rückflug

Namespace: Der Namespace für den Knoten Element.

---

getNamespace(prefix)

Ruft den Namespace mit dem angegebenen Präfix für den Element-Knoten ab.

Parameter

Name	Typ	Beschreibung
prefix	String	Das Präfix für den Namespace.

Rückflug

Namespace: Der Namespace mit dem angegebenen Präfix für den Element-Knoten.

---

getParentElement()

Ruft den übergeordneten Element-Knoten des Knotens ab. Wenn der Knoten kein übergeordnetes Element hat, wird null zurückgegeben.

Rückflug

Element|null: Der übergeordnete Element-Knoten.

---

getQualifiedName()

Ruft den lokalen Namen und das Namespace-Präfix des Element-Knotens im Format [namespacePrefix]:[localName] ab. Wenn der Knoten kein Namespace-Präfix hat, verwenden Sie getName().

Rückflug

String: Der lokale Name und das Namespace-Präfix des Element-Knotens im Format [namespacePrefix]:[localName].

---

getText()

Ruft den Textwert des Knotens Element ab.

Rückflug

String: Der Textwert des Knotens Element.

---

getValue()

Ruft den Textwert aller Knoten ab, die direkte oder indirekte untergeordnete Elemente des Knotens sind, in der Reihenfolge, in der sie im Dokument angezeigt werden.

Rückflug

String: Der Textwert aller Knoten, die direkte oder indirekte untergeordnete Elemente des Knotens sind.

---

isAncestorOf(other)

Gibt an, ob dieser Element-Knoten ein direktes oder indirektes übergeordnetes Element eines bestimmten Element-Knotens ist.

Parameter

Name	Typ	Beschreibung
other	Element	Der andere Element-Knoten.

Rückflug

Boolean – true, wenn dieser Element-Knoten ein direktes oder indirektes übergeordnetes Element des angegebenen Element-Knotens ist; false, wenn nicht.

---

isRootElement()

Gibt an, ob der Knoten Element der Stammknoten des Dokuments ist.

Rückflug

Boolean – true, wenn der Knoten Element der Stammknoten des Dokuments ist; false, wenn nicht.

---

removeAttribute(attribute)

Entfernt das angegebene Attribut für diesen Element-Knoten, sofern ein solches Attribut vorhanden ist.

Parameter

Name	Typ	Beschreibung
attribute	Attribute	Das Attribut.

Rückflug

Boolean – true, wenn das Attribut vorhanden war und entfernt wurde; false, wenn nicht.

---

removeAttribute(attributeName)

Entfernt das Attribut für diesen Element-Knoten mit dem angegebenen Namen und ohne Namespace, falls ein solches Attribut vorhanden ist.

Parameter

Name	Typ	Beschreibung
attributeName	String	Der Name des Attributs.

Rückflug

Boolean – true, wenn das Attribut vorhanden war und entfernt wurde; false, wenn nicht.

---

removeAttribute(attributeName, namespace)

Entfernt das Attribut für diesen Element-Knoten mit dem angegebenen Namen und Namespace, falls ein solches Attribut vorhanden ist.

Parameter

Name	Typ	Beschreibung
attributeName	String	Der Name des Attributs.
namespace	Namespace	Der Namespace des Attributs.

Rückflug

Boolean – true, wenn das Attribut vorhanden war und entfernt wurde; false, wenn nicht.

---

removeContent()

Entfernt alle Knoten, die direkte untergeordnete Elemente des {@code Element}-Knotens sind.

Rückflug

Content[]: Ein Array aller Knoten, die vor dem Entfernen unmittelbare untergeordnete Elemente des {@code Element}-Knotens waren.

---

removeContent(content)

Entfernt den angegebenen Knoten, wenn er ein direkt untergeordnetes Element des {@code Element}-Knotens ist. Das Argument content kann ein Element-Objekt oder ein beliebiges Knotenobjekt sein, das einem in ContentType aufgeführten Typ entspricht.

Parameter

Name	Typ	Beschreibung
content	Content	Der zu entfernende Knoten.

Rückflug

Boolean – true, wenn der Knoten ein direkt untergeordnetes Element war und entfernt wurde; false, wenn nicht.

---

removeContent(index)

Entfernt den Knoten am angegebenen Index unter allen Knoten, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind. Wenn am angegebenen Index kein Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

Name	Typ	Beschreibung
index	Integer	Der Index für den Knoten unter allen Knoten, die direkte untergeordnete Elemente des {@code Element}-Knotens sind.

Rückflug

Content|null: Der Knoten, der entfernt wurde, oder null, wenn am angegebenen Index kein Knoten vorhanden ist.

---

setAttribute(attribute)

Legt das angegebene Attribut für diesen Element-Knoten fest.

Parameter

Name	Typ	Beschreibung
attribute	Attribute	Das festzulegende Attribut.

Rückflug

Element: Der Knoten Element zur Verkettung.

---

setAttribute(name, value)

Legt das Attribut für diesen Element-Knoten mit dem angegebenen Namen und Wert und ohne Namespace fest.

Parameter

Name	Typ	Beschreibung
name	String	Der Name des Attributs, das festgelegt werden soll.
value	String	Der Wert des Attributs, der festgelegt werden soll.

Rückflug

Element: Der Knoten Element zur Verkettung.

---

setAttribute(name, value, namespace)

Legt das Attribut für diesen Element-Knoten mit dem angegebenen Namen, Wert und Namespace fest.

Parameter

Name	Typ	Beschreibung
name	String	Der Name des Attributs, das festgelegt werden soll.
value	String	Der Wert des Attributs, der festgelegt werden soll.
namespace	Namespace	Der Namespace des festzulegenden Attributs.

Rückflug

Element: Der Knoten Element zur Verkettung.

---

setName(name)

Legt den lokalen Namen des Element-Knotens fest. Um ein Namespace-Präfix für den Knoten festzulegen, verwenden Sie setNamespace(namespace) in Kombination mit XmlService.getNamespace(prefix, uri).

Parameter

Name	Typ	Beschreibung
name	String	Der festzulegende lokale Name.

Rückflug

Element: Der Knoten Element zur Verkettung.

---

setNamespace(namespace)

Legt den Namespace für den Knoten Element fest.

Parameter

Name	Typ	Beschreibung
namespace	Namespace	Der festzulegende Namespace.

Rückflug

Element: Der Knoten Element zur Verkettung.

---

setText(text)

Legt den Textwert des Knotens Element fest. Wenn der Knoten bereits einen Textwert oder untergeordnete Knoten enthält, werden die alten Inhalte durch diese Methode überschrieben. Wenn Sie stattdessen Inhalte anhängen oder einfügen möchten, verwenden Sie addContent(content) oder addContent(index, content).

Parameter

Name	Typ	Beschreibung
text	String	Der festzulegende Text.

Rückflug

Element: Der Knoten Element zur Verkettung.