Class Element

Element

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 Element-Knotens an.
addContent(index, content)ElementFügt den angegebenen Knoten beim angegebenen Index aus allen Knoten ein, die unmittelbar untergeordnete Knoten des Element-Knotens sind.
cloneContent()Content[]Erstellt nicht angehängte Kopien aller Knoten, die unmittelbar untergeordnete Objekte des Knotens {@code Element} sind.
detach()ContentTrennt den Knoten vom übergeordneten Knoten Element.
getAllContent()Content[]Ruft alle Knoten ab, die dem {@code Element}-Knoten direkt 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 ohne Namespace ab, der dem Element-Knoten direkt untergeordnet ist.
getChild(name, namespace)ElementRuft den ersten Element-Knoten mit dem angegebenen Namen und Namespace ab, der ein unmittelbar untergeordnetes Element dieses Element-Knotens ist.
getChildText(name)StringRuft den Textwert des Knotens mit dem angegebenen Namen und ohne Namespace ab, wenn der Knoten ein untergeordnetes Element des Knotens Element ist.
getChildText(name, namespace)StringRuft den Textwert des Knotens mit dem angegebenen Namen und Namespace ab, wenn der Knoten ein unmittelbar untergeordnetes Element des Element-Knotens 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 unmittelbar 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 unmittelbar untergeordnete Elemente dieses Element-Knotens sind, in der Reihenfolge, in der sie im Dokument angezeigt werden.
getContent(index)ContentRuft den Knoten beim angegebenen Index aus allen Knoten ab, die unmittelbar untergeordnete Knoten des {@code Element}-Knotens sind.
getContentSize()IntegerRuft die Anzahl der Knoten ab, die dem {@code Element}-Knoten direkt untergeordnet 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()DocumentRuft das XML-Dokument ab, das den Knoten {@code Element} enthält.
getName()StringRuft den lokalen Namen des Element-Knotens 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 ab.
getQualifiedName()StringRuft den lokalen Namen und das Namespace-Präfix des Element-Knotens im Format [namespacePrefix]:[localName] ab.
getText()StringRuft den Textwert des Element-Knotens ab.
getValue()StringRuft den Textwert aller Knoten ab, die direkte oder indirekte untergeordnete Elemente des Knotens in der Reihenfolge sind, in der sie im Dokument angezeigt werden.
isAncestorOf(other)BooleanLegt fest, 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, wenn ein solches Attribut vorhanden ist.
removeAttribute(attributeName)BooleanEntfernt das Attribut für diesen Element-Knoten mit dem angegebenen Namen und ohne Namespace, falls ein solches Attribut vorhanden ist.
removeAttribute(attributeName, namespace)BooleanEntfernt das Attribut für diesen Element-Knoten mit dem angegebenen Namen und Namespace, sofern vorhanden.
removeContent()Content[]Entfernt alle Knoten, die unmittelbar untergeordnete Knoten des {@code Element}-Knotens sind.
removeContent(content)BooleanEntfernt den angegebenen Knoten, wenn der Knoten ein unmittelbares untergeordnetes Element des Knotens {@code Element} ist.
removeContent(index)ContentEntfernt den Knoten am angegebenen Index aus allen Knoten, die unmittelbar untergeordnete Knoten des {@code Element}-Knotens 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 Element-Knotens fest.
setNamespace(namespace)ElementLegt den Namespace für den Knoten Element fest.
setText(text)ElementLegt den Textwert des Element-Knotens fest.

Detaillierte Dokumentation

addContent(content)

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

Parameter

NameTypBeschreibung
contentContentden anzufügenden Knoten

Zurücksenden

Element: der Element-Knoten für die Verkettung


addContent(index, content)

Fügt den angegebenen Knoten beim angegebenen Index aus allen Knoten ein, die unmittelbar untergeordnete Knoten 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

NameTypBeschreibung
indexIntegerIndex, an dem der Knoten unter allen Knoten eingefügt werden soll, die unmittelbar untergeordnete Knoten des Element-Knotens sind
contentContentden einzufügenden Knoten

Zurücksenden

Element: der Element-Knoten für die Verkettung


cloneContent()

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

Zurücksenden

Content[]: ein Array von nicht angehängten Kopien aller Knoten, die direkte untergeordnete Elemente des Knotens {@code Element} sind


detach()

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

Zurücksenden

Content: der getrennte Knoten


getAllContent()

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

Zurücksenden

Content[]: ein Array aller Knoten, die unmittelbar untergeordnete Knoten 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

NameTypBeschreibung
nameStringDer Name des Attributs

Zurücksenden

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

NameTypBeschreibung
nameStringDer Name des Attributs
namespaceNamespaceNamespace des Attributs

Zurücksenden

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.

Zurücksenden

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 dem Element-Knoten direkt untergeordnet ist. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

NameTypBeschreibung
nameStringName des untergeordneten Element-Knotens

Zurücksenden

Element: der Element-Knoten oder null, wenn kein unmittelbarer untergeordneter Element-Knoten mit dem angegebenen Namen und ohne Namespace vorhanden ist


getChild(name, namespace)

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

Parameter

NameTypBeschreibung
nameStringName des untergeordneten Element-Knotens
namespaceNamespaceNamespace des untergeordneten Element-Knotens

Zurücksenden

Element: der Element-Knoten oder null, wenn kein unmittelbarer untergeordneter Element-Knoten mit dem angegebenen Namen und Namespace vorhanden ist


getChildText(name)

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

Parameter

NameTypBeschreibung
nameStringName des untergeordneten Knotens

Zurücksenden

String: Textwert des untergeordneten Knotens oder null, wenn kein unmittelbarer untergeordneter Knoten mit dem angegebenen Namen und kein Namespace vorhanden ist


getChildText(name, namespace)

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

Parameter

NameTypBeschreibung
nameStringName des untergeordneten Knotens
namespaceNamespaceNamespace des untergeordneten Knotens

Zurücksenden

String: Textwert des untergeordneten Knotens oder null, wenn kein unmittelbarer untergeordneter Knoten mit dem angegebenen Namen und Namespace angegeben ist


getChildren()

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

Zurücksenden

Element[]: ein Array aller Element Knoten, die unmittelbar untergeordnete Knoten dieses Element-Knotens sind


getChildren(name)

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

Parameter

NameTypBeschreibung
nameStringden Namen der untergeordneten Element-Knoten

Zurücksenden

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


getChildren(name, namespace)

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

Parameter

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

Zurücksenden

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


getContent(index)

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

Parameter

NameTypBeschreibung
indexIntegerIndex für den Knoten aller Knoten, die unmittelbar untergeordnete Elemente des {@code Element}-Knotens sind

Zurücksenden

Content: der Knoten oder null, wenn kein Knoten im angegebenen Index vorhanden ist


getContentSize()

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

Zurücksenden

Integer: Anzahl der Knoten, die dem {@code Element}-Knoten direkt untergeordnet 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.

Zurücksenden

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


getDocument()

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

Zurücksenden

Document: das Dokument mit dem Knoten {@code Element}


getName()

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

Zurücksenden

String: Der lokale Name des Element-Knotens


getNamespace()

Ruft den Namespace für den Knoten Element ab.

Zurücksenden

Namespace: Der 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

Zurücksenden

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


getParentElement()

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

Zurücksenden

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

Zurücksenden

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


getText()

Ruft den Textwert des Element-Knotens ab.

Zurücksenden

String: Textwert des Knotens Element


getValue()

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

Zurücksenden

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


isAncestorOf(other)

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

Parameter

NameTypBeschreibung
otherElementder andere Element-Knoten

Zurücksenden

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


isRootElement()

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

Zurücksenden

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


removeAttribute(attribute)

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

Parameter

NameTypBeschreibung
attributeAttributedas Attribut

Zurücksenden

Boolean: true, wenn das Attribut vorhanden und entfernt wurde; andernfalls false


removeAttribute(attributeName)

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

Parameter

NameTypBeschreibung
attributeNameStringDer Name des Attributs

Zurücksenden

Boolean: true, wenn das Attribut vorhanden und entfernt wurde; andernfalls false


removeAttribute(attributeName, namespace)

Entfernt das Attribut für diesen Element-Knoten mit dem angegebenen Namen und Namespace, sofern vorhanden.

Parameter

NameTypBeschreibung
attributeNameStringDer Name des Attributs
namespaceNamespaceNamespace des Attributs

Zurücksenden

Boolean: true, wenn das Attribut vorhanden und entfernt wurde; andernfalls false


removeContent()

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

Zurücksenden

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


removeContent(content)

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

Parameter

NameTypBeschreibung
contentContentden zu entfernenden Knoten

Zurücksenden

Boolean: true, wenn der Knoten ein unmittelbares untergeordnetes Element wurde und entfernt wurde; andernfalls false


removeContent(index)

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

Parameter

NameTypBeschreibung
indexIntegerIndex für den Knoten aller Knoten, die unmittelbar untergeordnete Elemente des {@code Element}-Knotens sind

Zurücksenden

Content: Der entfernte Knoten oder null, wenn kein Knoten im angegebenen Index vorhanden ist


setAttribute(attribute)

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

Parameter

NameTypBeschreibung
attributeAttributedas festzulegende Attribut

Zurücksenden

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
nameStringDer Name des festzulegenden Attributs
valueStringWert des festzulegenden Attributs

Zurücksenden

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
nameStringDer Name des festzulegenden Attributs
valueStringWert des festzulegenden Attributs
namespaceNamespaceDer festzulegende Namespace des Attributs

Zurücksenden

Element: der Element-Knoten für die Verkettung


setName(name)

Legt den lokalen Namen des Element-Knotens 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

Zurücksenden

Element: der Element-Knoten für die Verkettung


setNamespace(namespace)

Legt den Namespace für den Knoten Element fest.

Parameter

NameTypBeschreibung
namespaceNamespaceDer festzulegende Namespace

Zurücksenden

Element: der Element-Knoten für die Verkettung


setText(text)

Legt den Textwert des Element-Knotens fest. Wenn der Knoten bereits einen Textwert oder einen untergeordneten Knoten enthält, überschreibt diese Methode den alten Inhalt. Verwenden Sie stattdessen addContent(content) oder addContent(index, content), um Inhalte anzuhängen oder einzufügen.

Parameter

NameTypBeschreibung
textStringden festzulegenden Text

Zurücksenden

Element: der Element-Knoten für die Verkettung