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

MethodeRückgabetypKurzbeschreibung
addContent(content)ElementDer angegebene Knoten wird als letztes untergeordnetes Element des Element-Knotens angehängt.
addContent(index, content)ElementDer angegebene Knoten wird an der angegebenen Position unter allen Knoten eingefügt, die unmittelbare untergeordnete Knoten des Knotens Element sind.
cloneContent()Content[]Es werden losgelöste Kopien aller Knoten erstellt, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind.
detach()ContentDer Knoten wird von seinem übergeordneten Knoten Element getrennt.
getAllContent()Content[]Hiermit werden alle Knoten abgerufen, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens 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[]Hier werden alle Attribute für diesen Element-Knoten in der Reihenfolge abgerufen, in der sie im Dokument erscheinen.
getChild(name)ElementRuft den ersten Element-Knoten mit dem angegebenen Namen und ohne Namespace ab, der ein direktes Kind dieses Element-Knotens ist.
getChild(name, namespace)ElementRuft den ersten Element-Knoten mit dem angegebenen Namen und Namespace ab, der ein direktes Kind dieses Element-Knotens ist.
getChildText(name)StringRuft den Textwert des Knotens mit dem angegebenen Namen und ohne Namespace ab, wenn der Knoten ein direktes Kind des Knotens Element ist.
getChildText(name, namespace)StringRuft den Textwert des Knotens mit dem angegebenen Namen und Namespace ab, wenn der Knoten ein direktes Kind 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 erscheinen.
getChildren(name)Element[]Hiermit werden alle Element-Knoten mit dem angegebenen Namen und ohne Namespace abgerufen, die unmittelbare Unterknoten dieses Element-Knotens sind. Die Knoten werden in der Reihenfolge abgerufen, in der sie im Dokument vorkommen.
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 erscheinen.
getContent(index)ContentRuft den Knoten mit dem angegebenen Index aus allen Knoten ab, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind.
getContentSize()IntegerDie Anzahl der Knoten, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind.
getDescendants()Content[]Hier werden alle Knoten abgerufen, die direkte oder indirekte untergeordnete Elemente des {@code Element}-Knotens sind, in der Reihenfolge, in der sie im Dokument erscheinen.
getDocument()DocumentRuft das XML-Dokument ab, das den Knoten {@code Element} enthält.
getName()StringDer lokale Name des Element-Knotens.
getNamespace()NamespaceRuft den Namespace für den Knoten Element ab.
getNamespace(prefix)NamespaceRuft den Namespace mit dem angegebenen Präfix für den Element-Knoten ab.
getParentElement()ElementRuft den übergeordneten Element-Knoten 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 ab, die direkte oder indirekte untergeordnete Elemente des Knotens sind, in der Reihenfolge, in der sie im Dokument erscheinen.
isAncestorOf(other)BooleanBestimmt, ob dieser Element-Knoten ein direkter oder indirekter übergeordneter Knoten eines bestimmten Element-Knotens ist.
isRootElement()BooleanBestimmt, ob der Element-Knoten der Stammknoten des Dokuments ist.
removeAttribute(attribute)BooleanEntfernt das angegebene Attribut für diesen Element-Knoten, sofern vorhanden.
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, falls ein solches Attribut vorhanden ist.
removeContent()Content[]Entfernt alle Knoten, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind.
removeContent(content)BooleanEntfernt den angegebenen Knoten, wenn er ein direktes untergeordnetes Element des {@code Element}-Knotens ist.
removeContent(index)ContentEntfernt den Knoten am angegebenen Index aus allen Knoten, die unmittelbare untergeordnete Elemente des Knotens {@code Element} sind.
setAttribute(attribute)ElementLegt das angegebene Attribut für diesen Element-Knoten fest.
setAttribute(name, value)ElementHiermit wird das Attribut für diesen Element-Knoten mit dem angegebenen Namen, Wert und ohne Namespace festgelegt.
setAttribute(name, value, namespace)ElementHiermit wird das Attribut für diesen Element-Knoten mit dem angegebenen Namen, Wert und Namespace festgelegt.
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 Knotens Element fest.

Detaillierte Dokumentation

addContent(content)

Der angegebene Knoten wird als letztes untergeordnetes Element des Element-Knotens angehängt. Das Argument content kann ein Element-Objekt oder ein beliebiges Knotenobjekt sein, das einem in ContentType aufgeführten Typ entspricht.

Parameter

NameTypBeschreibung
contentContentDer Knoten, der angehängt werden soll

Rückflug

Element – der Element-Knoten für die Verkettung

addContent(index, content)

Der angegebene Knoten wird an der angegebenen Position unter allen Knoten eingefügt, die unmittelbare untergeordnete Knoten des Knotens Element sind. Das content-Argument kann ein Element-Objekt oder ein beliebiges Knotenobjekt sein, das einem in ContentType aufgeführten Typ entspricht.

Parameter

NameTypBeschreibung
indexIntegerder Index, an dem der Knoten unter allen Knoten eingefügt werden soll, die dem Knoten Element direkt untergeordnet sind
contentContentden einzufügenden Knoten

Rückflug

Element – der Element-Knoten für die Verkettung

cloneContent()

Es werden losgelöste Kopien aller Knoten erstellt, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind.

Rückflug

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

detach()

Der Knoten wird von seinem übergeordneten Knoten Element getrennt. Wenn der Knoten kein übergeordnetes Element hat, hat diese Methode keine Auswirkungen.

Rückflug

Content – der getrennte Knoten

getAllContent()

Hiermit werden alle Knoten abgerufen, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind.

Rückflug

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

NameTypBeschreibung
nameStringden Namen des Attributs

Rückflug

Attribute – das Attribut oder null, wenn es kein Attribut mit dem angegebenen Namen und keinen Namespace gibt

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

Rückflug

Attribute – das Attribut oder null, wenn es kein Attribut mit dem angegebenen Namen und Namespace gibt

getAttributes()

Hier werden alle Attribute für diesen Element-Knoten in der Reihenfolge abgerufen, in der sie im Dokument erscheinen.

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

Parameter

NameTypBeschreibung
nameStringden Namen des untergeordneten Element-Knotens

Rückflug

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 ein direktes Kind dieses Element-Knotens ist. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

NameTypBeschreibung
nameStringden Namen des untergeordneten Element-Knotens
namespaceNamespaceden Namespace des untergeordneten Element-Knotens

Rückflug

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 ein direktes Kind des Knotens Element ist. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

NameTypBeschreibung
nameStringDer Name des untergeordneten Knotens

Rückflug

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 ein direktes Kind des Knotens Element ist. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

NameTypBeschreibung
nameStringDer Name des untergeordneten Knotens
namespaceNamespaceden Namespace des untergeordneten Knotens

Rückflug

String: Der Textwert des untergeordneten Knotens oder null, wenn es keinen unmittelbaren 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 erscheinen.

Rückflug

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

getChildren(name)

Hiermit werden alle Element-Knoten mit dem angegebenen Namen und ohne Namespace abgerufen, die unmittelbare Unterknoten dieses Element-Knotens sind. Die Knoten werden in der Reihenfolge abgerufen, in der sie im Dokument vorkommen.

Parameter

NameTypBeschreibung
nameStringden Namen der untergeordneten Element-Knoten

Rückflug

Element[]: ein Array aller Element-Knoten mit dem angegebenen Namen und ohne Namespace, die unmittelbare 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 erscheinen.

Parameter

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

Rückflug

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

getContent(index)

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

Parameter

NameTypBeschreibung
indexIntegerder Index des Knotens unter allen Knoten, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind

Rückflug

Content – der Knoten oder null, wenn an der angegebenen Position kein Knoten vorhanden ist

getContentSize()

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

Rückflug

Integer – die Anzahl der Knoten, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind

getDescendants()

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

Rückflug

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

getDocument()

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

Rückflug

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

getName()

Der lokale Name des Element-Knotens. 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: Namespace für den Knoten Element

getNamespace(prefix)

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

Parameter

NameTypBeschreibung
prefixStringdas Präfix für den Namespace

Rückflug

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

getParentElement()

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

Rückflug

Element – der übergeordnete Knoten Element

getQualifiedName()

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

Rückflug

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

getText()

Ruft den Textwert des Knotens Element ab.

Rückflug

String: 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 erscheinen.

Rückflug

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

isAncestorOf(other)

Bestimmt, ob dieser Element-Knoten ein direkter oder indirekter übergeordneter Knoten eines bestimmten Element-Knotens ist.

Parameter

NameTypBeschreibung
otherElementden anderen Element-Knoten

Rückflug

Boolean – true, wenn dieser Element-Knoten ein direkter oder indirekter übergeordneter Knoten des angegebenen Element-Knotens ist; false andernfalls

isRootElement()

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

Rückflug

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

removeAttribute(attribute)

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

Parameter

NameTypBeschreibung
attributeAttributedas 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

NameTypBeschreibung
attributeNameStringden Namen 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

NameTypBeschreibung
attributeNameStringden Namen des Attributs
namespaceNamespaceden Namespace des Attributs

Rückflug

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

removeContent()

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

Rückflug

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

removeContent(content)

Entfernt den angegebenen Knoten, wenn er ein direktes 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
contentContentden zu entfernenden Knoten

Rückflug

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

removeContent(index)

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

Parameter

NameTypBeschreibung
indexIntegerder Index des Knotens unter allen Knoten, die unmittelbare untergeordnete Elemente des {@code Element}-Knotens sind

Rückflug

Content: der entfernte Knoten oder null, wenn an der angegebenen Position kein Knoten vorhanden ist

setAttribute(attribute)

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

Parameter

NameTypBeschreibung
attributeAttributedas Attribut, das festgelegt werden soll

Rückflug

Element – der Element-Knoten für die Verkettung

setAttribute(name, value)

Hiermit wird das Attribut für diesen Element-Knoten mit dem angegebenen Namen, Wert und ohne Namespace festgelegt.

Parameter

NameTypBeschreibung
nameStringden Namen des Attributs, das festgelegt werden soll
valueStringden Wert des Attributs, das festgelegt werden soll

Rückflug

Element – der Element-Knoten für die Verkettung

setAttribute(name, value, namespace)

Hiermit wird das Attribut für diesen Element-Knoten mit dem angegebenen Namen, Wert und Namespace festgelegt.

Parameter

NameTypBeschreibung
nameStringden Namen des Attributs, das festgelegt werden soll
valueStringden Wert des Attributs, das festgelegt werden soll
namespaceNamespaceder Namespace des Attributs, das festgelegt werden soll

Rückflug

Element – der Element-Knoten für die Verkettung

setName(name)

Legt den lokalen Namen des Element-Knotens fest. Wenn Sie ein Namespacepräfix für den Knoten festlegen möchten, verwenden Sie setNamespace(namespace) in Kombination mit XmlService.getNamespace(prefix, uri).

Parameter

NameTypBeschreibung
nameStringDer zu festlegende lokale Name

Rückflug

Element – der Element-Knoten für die Verkettung

setNamespace(namespace)

Legt den Namespace für den Knoten Element fest.

Parameter

NameTypBeschreibung
namespaceNamespaceden zu setzenden Namespace

Rückflug

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, werden die alten Inhalte mit dieser Methode überschrieben. Wenn Sie Inhalte anhängen oder einfügen möchten, verwenden Sie stattdessen addContent(content) oder addContent(index, content).

Parameter

NameTypBeschreibung
textStringDer Text, der festgelegt werden soll

Rückflug

Element – der Element-Knoten für die Verkettung