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

Methoden

MethodeRückgabetypKurzbeschreibung
addContent(content)ElementHängt den angegebenen Knoten als letztes untergeordnetes Element des Knotens Element an.
addContent(index, content)ElementFügt den angegebenen Knoten beim angegebenen Index unter allen Knoten ein, die unmittelbar dem Knoten Element untergeordnet sind.
cloneContent()Content[]Erstellt nicht angehängte Kopien aller Knoten, die dem {@code Element}-Knoten unmittelbar untergeordnet sind.
detach()ContentTrennt den Knoten vom übergeordneten Knoten Element.
getAllContent()Content[]Ruft alle Knoten ab, die dem Knoten {@code Element} unmittelbar untergeordnet sind.
getAttribute(name)AttributeRuft das Attribut für diesen Element-Knoten mit dem angegebenen Namen und ohne Namespace ab.
getAttribute(name, namespace)AttributeRuft 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)ElementRuft den ersten Element-Knoten mit dem angegebenen Namen und keinem Namespace ab, der diesem Element-Knoten unmittelbar untergeordnet ist.
getChild(name, namespace)ElementRuft den ersten Element-Knoten mit dem angegebenen Namen und Namespace ab, der diesem Element-Knoten unmittelbar untergeordnet ist.
getChildText(name)StringRuft den Textwert des Knotens mit dem angegebenen Namen und ohne Namespace ab, wenn der Knoten dem Knoten Element unmittelbar untergeordnet ist.
getChildText(name, namespace)StringRuft den Textwert des Knotens mit dem angegebenen Namen und Namespace ab, wenn der Knoten dem Knoten Element unmittelbar untergeordnet ist.
getChildren()Element[]Ruft alle Element-Knoten, die diesem Element-Knoten unmittelbar untergeordnet sind, in der Reihenfolge ab, in der sie im Dokument aufgeführt sind.
getChildren(name)Element[]Ruft alle Element-Knoten mit dem angegebenen Namen und ohne Namespace ab, die diesem Element-Knoten unmittelbar untergeordnet 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, die diesem Element-Knoten unmittelbar untergeordnet sind, in der Reihenfolge ab, in der sie im Dokument aufgeführt sind.
getContent(index)ContentRuft den Knoten beim angegebenen Index aus allen Knoten ab, die dem Knoten {@code Element} unmittelbar untergeordnet sind.
getContentSize()IntegerRuft die Anzahl der Knoten ab, die dem {@code Element}-Knoten unmittelbar untergeordnet sind.
getDescendants()Content[]Ruft alle Knoten, die direkte oder indirekte untergeordnete Knoten des {@code Element}-Knotens sind, in der Reihenfolge ab, in der sie im Dokument angezeigt werden.
getDocument()DocumentRuft das XML-Dokument ab, das den Knoten {@code Element} enthält.
getName()StringRuft den lokalen Namen des Knotens Element ab.
getNamespace()NamespaceRuft den Namespace für den Knoten Element ab.
getNamespace(prefix)NamespaceRuft den Namespace mit dem angegebenen Präfix für den Knoten Element ab.
getParentElement()ElementRuft den übergeordneten Knoten Element des Knotens ab.
getQualifiedName()StringRuft den lokalen Namen und das Namespace-Präfix des Element-Knotens im Format [namespacePrefix]:[localName] ab.
getText()StringRuft den Textwert des Knotens Element ab.
getValue()StringRuft den Textwert aller Knoten, die direkte oder indirekte untergeordnete Knoten des Knotens sind, in der Reihenfolge ab, in der sie im Dokument angezeigt werden.
isAncestorOf(other)BooleanBestimmt, ob dieser Element-Knoten ein direktes oder indirektes übergeordnetes Element eines bestimmten Element-Knotens ist.
isRootElement()BooleanBestimmt, ob der Knoten Element der Stammknoten des Dokuments ist.
removeAttribute(attribute)BooleanEntfernt das angegebene Attribut für diesen Element-Knoten, falls ein solches Attribut vorhanden ist.
removeAttribute(attributeName)BooleanEntfernt das Attribut für diesen Element-Knoten mit dem angegebenen Namen und ohne Namespace, wenn ein solches Attribut vorhanden ist.
removeAttribute(attributeName, namespace)BooleanEntfernt 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 dem {@code Element}-Knoten unmittelbar untergeordnet sind.
removeContent(content)BooleanEntfernt den angegebenen Knoten, wenn der Knoten ein unmittelbares untergeordnetes Element des {@code Element}-Knotens ist.
removeContent(index)ContentEntfernt den Knoten beim angegebenen Index aus allen Knoten, die dem Knoten {@code Element} unmittelbar untergeordnet sind.
setAttribute(attribute)ElementLegt das angegebene Attribut für diesen Element-Knoten fest.
setAttribute(name, value)ElementLegt das Attribut für diesen Element-Knoten mit dem angegebenen Namen, Wert und ohne Namespace fest.
setAttribute(name, value, namespace)ElementLegt das Attribut für diesen Element-Knoten mit dem angegebenen Namen, Wert und Namespace fest.
setName(name)ElementLegt den lokalen Namen des Knotens Element fest.
setNamespace(namespace)ElementLegt den Namespace für den Knoten Element fest.
setText(text)ElementLegt den Textwert des Knotens Element fest.

Detaillierte Dokumentation

addContent(content)

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

Parameter

NameTypBeschreibung
contentContentAnzuhängender Knoten

Return

Element: der Element-Knoten für die Verkettung


addContent(index, content)

Fügt den angegebenen Knoten beim angegebenen Index unter allen Knoten ein, die unmittelbar dem Knoten Element untergeordnet sind. Das Argument content kann ein Element-Objekt oder ein beliebiges Knotenobjekt sein, das einem in ContentType aufgeführten Typ entspricht.

Parameter

NameTypBeschreibung
indexIntegerIndex, an dem der Knoten unter allen Knoten eingefügt werden soll, die unmittelbar dem Knoten Element untergeordnet sind
contentContentKnoten, der eingefügt werden soll

Return

Element: der Element-Knoten für die Verkettung


cloneContent()

Erstellt nicht angehängte Kopien aller Knoten, die dem {@code Element}-Knoten unmittelbar untergeordnet sind.

Return

Content[]: ein Array nicht angehängter Kopien aller Knoten, die dem Knoten {@code Element} unmittelbar untergeordnet sind


detach()

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

Return

Content: der getrennte Knoten


getAllContent()

Ruft alle Knoten ab, die dem Knoten {@code Element} unmittelbar untergeordnet sind.

Return

Content[]: ein Array aller Knoten, die unmittelbar untergeordnete Elemente des Knotens {@code Element} 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

NameTypBeschreibung
nameStringden Namen des Attributs

Return

Attribute: das Attribut oder null, wenn kein Attribut mit dem angegebenen Namen und ohne Namespace vorhanden ist


getAttribute(name, namespace)

Ruft das Attribut für diesen Element-Knoten mit dem angegebenen Namen und Namespace ab. Wenn es keinen solchen Knoten gibt, gibt diese Methode null zurück.

Parameter

NameTypBeschreibung
nameStringden Namen des Attributs
namespaceNamespaceden Namespace des Attributs

Return

Attribute: 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.

Return

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


getChild(name)

Ruft den ersten Element-Knoten mit dem angegebenen Namen und keinem Namespace ab, der diesem Element-Knoten unmittelbar untergeordnet ist. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

NameTypBeschreibung
nameStringden Namen des untergeordneten Element-Knotens

Return

Element: der Element-Knoten oder null, wenn es keinen unmittelbaren untergeordneten Element-Knoten mit dem angegebenen Namen und ohne Namespace gibt


getChild(name, namespace)

Ruft den ersten Element-Knoten mit dem angegebenen Namen und Namespace ab, der diesem Element-Knoten unmittelbar untergeordnet ist. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

NameTypBeschreibung
nameStringden Namen des untergeordneten Element-Knotens
namespaceNamespaceNamespace des untergeordneten Knotens „Element

Return

Element: der Element-Knoten oder null, wenn es keinen unmittelbaren untergeordneten Element-Knoten 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 dem Knoten Element unmittelbar untergeordnet ist. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

NameTypBeschreibung
nameStringden Namen des untergeordneten Knotens

Return

String: der Textwert des untergeordneten Knotens oder null, wenn es keinen unmittelbaren untergeordneten Knoten mit dem angegebenen Namen und ohne Namespace gibt


getChildText(name, namespace)

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

Parameter

NameTypBeschreibung
nameStringden Namen des untergeordneten Knotens
namespaceNamespaceNamespace des untergeordneten Knotens

Return

String – Textwert des untergeordneten Knotens oder null, wenn es keinen unmittelbaren untergeordneten Knoten mit dem angegebenen Namen und Namespace gibt


getChildren()

Ruft alle Element-Knoten, die diesem Element-Knoten unmittelbar untergeordnet sind, in der Reihenfolge ab, in der sie im Dokument aufgeführt sind.

Return

Element[]: ein Array aller Element-Knoten, die unmittelbar diesem Element-Knoten untergeordnet sind


getChildren(name)

Ruft alle Element-Knoten mit dem angegebenen Namen und ohne Namespace ab, die diesem Element-Knoten unmittelbar untergeordnet sind, in der Reihenfolge, in der sie im Dokument angezeigt werden.

Parameter

NameTypBeschreibung
nameStringden Namen der untergeordneten Element-Knoten

Return

Element[]: ein Array aller Element-Knoten mit dem angegebenen Namen und ohne Namespace, die diesem Element-Knoten unmittelbar untergeordnet sind


getChildren(name, namespace)

Ruft alle Element-Knoten mit dem angegebenen Namen und Namespace, die diesem Element-Knoten unmittelbar untergeordnet sind, in der Reihenfolge ab, in der sie im Dokument aufgeführt sind.

Parameter

NameTypBeschreibung
nameStringden Namen der untergeordneten Element-Knoten
namespaceNamespaceden Namespace der untergeordneten Element-Knoten

Return

Element[]: ein Array aller Element-Knoten mit dem angegebenen Namen und Namespace, die diesem Element-Knoten unmittelbar untergeordnet sind


getContent(index)

Ruft den Knoten beim angegebenen Index aus allen Knoten ab, die dem Knoten {@code Element} unmittelbar untergeordnet sind. Wenn sich am angegebenen Index kein Knoten befindet, gibt diese Methode null zurück.

Parameter

NameTypBeschreibung
indexIntegerIndex für den Knoten unter allen Knoten, die unmittelbar dem {@code Element}-Knoten untergeordnet sind

Return

Content: der Knoten oder null, wenn sich am angegebenen Index kein Knoten befindet


getContentSize()

Ruft die Anzahl der Knoten ab, die dem {@code Element}-Knoten unmittelbar untergeordnet sind.

Return

Integer: die Anzahl der Knoten, die dem Knoten {@code Element} unmittelbar untergeordnet sind


getDescendants()

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

Return

Content[]: ein Array aller Knoten, die dem Knoten {@code Element} direkt oder indirekt untergeordnet sind


getDocument()

Ruft das XML-Dokument ab, das den Knoten {@code Element} enthält.

Return

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


getName()

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

Return

String: der lokale Name des Element-Knotens


getNamespace()

Ruft den Namespace für den Knoten Element ab.

Return

Namespace – Namespace für den Knoten Element


getNamespace(prefix)

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

Parameter

NameTypBeschreibung
prefixStringDas Präfix für den Namespace

Return

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


getParentElement()

Ruft den übergeordneten Knoten Element des Knotens ab. Wenn der Knoten kein übergeordnetes Element hat, gibt diese Methode null zurück.

Return

Element: 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().

Return

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


getText()

Ruft den Textwert des Knotens Element ab.

Return

String – der Textwert des Knotens Element


getValue()

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

Return

String: Textwert aller Knoten, die dem Knoten direkte oder indirekte untergeordnete Knoten sind


isAncestorOf(other)

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

Parameter

NameTypBeschreibung
otherElementden anderen Element-Knoten

Return

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


isRootElement()

Bestimmt, ob der Knoten Element der Stammknoten des Dokuments ist.

Return

Boolean: true, wenn der Element-Knoten der Root-Knoten des Dokuments ist; false, wenn nicht


removeAttribute(attribute)

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

Parameter

NameTypBeschreibung
attributeAttributedas Attribut

Return

Boolean: true, wenn das Attribut existierte und entfernt wurde; false wenn nicht


removeAttribute(attributeName)

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

Parameter

NameTypBeschreibung
attributeNameStringden Namen des Attributs

Return

Boolean: true, wenn das Attribut existierte 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

NameTypBeschreibung
attributeNameStringden Namen des Attributs
namespaceNamespaceden Namespace des Attributs

Return

Boolean: true, wenn das Attribut existierte und entfernt wurde; false wenn nicht


removeContent()

Entfernt alle Knoten, die dem {@code Element}-Knoten unmittelbar untergeordnet sind.

Return

Content[]: ein Array aller Knoten, die unmittelbare untergeordnete Elemente des Knotens {@code Element} waren, bevor sie entfernt wurden


removeContent(content)

Entfernt den angegebenen Knoten, wenn der Knoten ein unmittelbares 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

NameTypBeschreibung
contentContentZu entfernender Knoten

Return

Boolean: true, wenn der Knoten ein unmittelbar untergeordnetes Element war und entfernt wurde; false, wenn nicht


removeContent(index)

Entfernt den Knoten beim angegebenen Index aus allen Knoten, die dem Knoten {@code Element} unmittelbar untergeordnet sind. Wenn sich am angegebenen Index kein Knoten befindet, gibt diese Methode null zurück.

Parameter

NameTypBeschreibung
indexIntegerIndex für den Knoten unter allen Knoten, die unmittelbar dem {@code Element}-Knoten untergeordnet sind

Return

Content – Der Knoten, der entfernt wurde, oder null, wenn sich am angegebenen Index kein Knoten befindet


setAttribute(attribute)

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

Parameter

NameTypBeschreibung
attributeAttributedas festzulegende Attribut

Return

Element: der Element-Knoten für die Verkettung


setAttribute(name, value)

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

Parameter

NameTypBeschreibung
nameStringden Namen des festzulegenden Attributs
valueStringden Wert des festzulegenden Attributs

Return

Element: der Element-Knoten für die Verkettung


setAttribute(name, value, namespace)

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

Parameter

NameTypBeschreibung
nameStringden Namen des festzulegenden Attributs
valueStringden Wert des festzulegenden Attributs
namespaceNamespaceden Namespace des festzulegenden Attributs

Return

Element: der Element-Knoten für die Verkettung


setName(name)

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

Parameter

NameTypBeschreibung
nameStringden festzulegenden lokalen Namen

Return

Element: der Element-Knoten für die Verkettung


setNamespace(namespace)

Legt den Namespace für den Knoten Element fest.

Parameter

NameTypBeschreibung
namespaceNamespaceNamespace, der festgelegt werden soll

Return

Element: der Element-Knoten für die Verkettung


setText(text)

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

Parameter

NameTypBeschreibung
textStringden festzulegenden Text

Return

Element: der Element-Knoten für die Verkettung