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
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addContent(content) | Element | Hängt den angegebenen Knoten als letztes untergeordnetes Element des Knotens Element an. |
addContent(index, content) | Element | Fügt den angegebenen Knoten beim angegebenen Index unter allen Knoten ein, die dem
Element Knoten. |
cloneContent() | Content[] | Erstellt nicht angehängte Kopien aller Knoten, die dem Knoten {@code Element} unmittelbar untergeordnet sind. |
detach() | Content | Trennt den Knoten vom übergeordneten Knoten Element . |
getAllContent() | Content[] | Ruft alle Knoten ab, die dem {@code Element}-Knoten unmittelbar untergeordnet sind. |
getAttribute(name) | Attribute | Ruft das Attribut für diesen Element -Knoten mit dem angegebenen Namen und ohne Namespace ab. |
getAttribute(name, namespace) | Attribute | 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 aufgeführt sind. |
getChild(name) | Element | Ruft den ersten Element -Knoten mit dem angegebenen Namen und ohne Namespace ab, der ein unmittelbarer Knoten ist
untergeordnetes Element dieses Element -Knotens. |
getChild(name, namespace) | Element | Ruft den ersten Element -Knoten mit dem angegebenen Namen und Namespace ab, der ein unmittelbarer Knoten ist
untergeordnetes Element dieses Element -Knotens. |
getChildText(name) | String | Ruft den Textwert des Knotens mit dem angegebenen Namen und ohne Namespace ab, wenn der Knoten ein
unmittelbares untergeordnetes Element des Knotens Element . |
getChildText(name, namespace) | String | Ruft den Textwert des Knotens mit dem angegebenen Namen und Namespace ab, wenn der Knoten ein sofortiger Knoten ist.
untergeordnetes Element des Knotens Element . |
getChildren() | Element[] | Ruft alle Element -Knoten ab, die diesem Element -Knoten unmittelbar untergeordnet sind, in der
in der sie im Dokument erscheinen. |
getChildren(name) | Element[] | Ruft alle Element -Knoten mit dem angegebenen Namen und ohne Namespace ab, die unmittelbar untergeordnete Elemente sind
dieses Element -Knotens 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 sind
und zwar in der Reihenfolge, in der sie im Dokument angezeigt werden.Element |
getContent(index) | Content | Ruft den Knoten am angegebenen Index unter allen Knoten ab, die unmittelbar untergeordnete Elemente des {@code Element}-Knotens. |
getContentSize() | Integer | Ruft die Anzahl der Knoten ab, die dem {@code Element}-Knoten unmittelbar untergeordnet sind. |
getDescendants() | Content[] | Ruft alle Knoten, die dem {@code Element}-Knoten direkt oder indirekt untergeordnet sind, in der Reihenfolge ab, in der sie im Dokument angezeigt werden. |
getDocument() | Document | Ruft das XML-Dokument ab, das den Knoten {@code Element} enthält. |
getName() | String | Ruft den lokalen Namen des Knotens Element 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 Knoten Element ab. |
getParentElement() | Element | Ruft den übergeordneten Element -Knoten des Knotens ab. |
getQualifiedName() | String | Ruft den lokalen Namen und das Namespace-Präfix des Knotens Element im Format [namespacePrefix]:[localName] ab. |
getText() | String | Ruft den Textwert des Knotens Element ab. |
getValue() | String | Ruft den Textwert aller Knoten ab, die dem Knoten direkt oder indirekt untergeordnet sind, in der Reihenfolge, werden sie im Dokument angezeigt. |
isAncestorOf(other) | Boolean | Legt fest, ob dieser Element -Knoten ein direktes oder indirektes übergeordnetes Element eines bestimmten Element -Knotens ist. |
isRootElement() | Boolean | Legt fest, ob der Element -Knoten 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, wenn
ob ein solches Attribut existiert. |
removeAttribute(attributeName, namespace) | Boolean | Entfernt das Attribut für diesen Element -Knoten mit dem angegebenen Namen und Namespace, sofern vorhanden
wenn ein Attribut vorhanden ist. |
removeContent() | Content[] | Entfernt alle Knoten, die dem {@code Element}-Knoten unmittelbar untergeordnet sind. |
removeContent(content) | Boolean | Entfernt den angegebenen Knoten, wenn dieser ein unmittelbares untergeordnetes Element des {@code Element}-Knotens ist. |
removeContent(index) | Content | Entfernt den Knoten am angegebenen Index aus allen Knoten, die unmittelbar untergeordnete Elemente des {@code Element}-Knotens. |
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, 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 Knotens Element 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)
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 Typ entspricht
aufgeführt in ContentType
.
Parameter
Name | Typ | Beschreibung |
---|---|---|
content | Content | den hinzuzufügenden Knoten |
Rückflug
Element
: der Element
-Knoten für Verkettung
addContent(index, content)
Fügt den angegebenen Knoten beim angegebenen Index unter allen Knoten ein, die dem
Element
Knoten. Das Argument content
kann ein Element
-Objekt oder ein beliebiges
Knotenobjekt, das einem in ContentType
aufgeführten Typ entspricht.
Parameter
Name | Typ | Beschreibung |
---|---|---|
index | Integer | Der Index, in dem der Knoten unter allen Knoten eingefügt werden soll, die unmittelbar untergeordnete Elemente sind
des Knotens Element |
content | Content | den einzufügenden Knoten |
Rückflug
Element
: der Element
-Knoten für Verkettung
cloneContent()
Erstellt nicht angehängte Kopien aller Knoten, die dem Knoten {@code Element} unmittelbar untergeordnet sind.
Rückflug
Content[]
: ein Array von nicht angehängten Kopien aller Knoten, die unmittelbar untergeordnete Elemente des
{@code-Element}-Knoten
detach()
getAllContent()
Ruft alle Knoten ab, die dem {@code Element}-Knoten unmittelbar untergeordnet sind.
Rückflug
Content[]
: ein Array aller Knoten, die dem Knoten {@code Element} unmittelbar untergeordnet sind
getAttribute(name)
Ruft das Attribut für diesen Element
-Knoten mit dem angegebenen Namen und ohne Namespace ab. Wenn es
gibt es kein solches Attribut, gibt diese Methode null
zurück.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen des Attributs |
Rückflug
Attribute
: das Attribut oder null
, wenn kein Attribut mit dem angegebenen Namen vorhanden ist und kein
Namespace
getAttribute(name, namespace)
Ruft das Attribut für diesen Element
-Knoten mit dem angegebenen Namen und Namespace ab. Wenn es
Knoten vorhanden ist, gibt diese Methode null
zurück.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen des Attributs |
namespace | Namespace | den Namespace des Attributs |
Rückflug
Attribute
– das Attribut oder null
, wenn kein Attribut mit dem angegebenen Namen vorhanden ist und
Namespace
getAttributes()
Ruft alle Attribute für diesen Element
-Knoten in der Reihenfolge ab, in der sie im Dokument aufgeführt sind.
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 unmittelbarer Knoten ist
untergeordnetes Element dieses Element
-Knotens. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null
zurück.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | Name des untergeordneten Knotens Element |
Rückflug
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 unmittelbarer Knoten ist
untergeordnetes Element dieses Element
-Knotens. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null
zurück.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | Name des untergeordneten Knotens Element |
namespace | Namespace | Den Namespace des untergeordneten Knotens Element |
Rückflug
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
unmittelbares untergeordnetes Element des Knotens Element
. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode
null
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen des untergeordneten Knotens |
Rückflug
String
: der Textwert des untergeordneten Knotens oder null
, wenn kein unmittelbarer untergeordneter Knoten vorhanden ist
mit dem angegebenen Namen und ohne Namespace
getChildText(name, namespace)
Ruft den Textwert des Knotens mit dem angegebenen Namen und Namespace ab, wenn der Knoten ein sofortiger Knoten ist.
untergeordnetes Element des Knotens Element
. Wenn kein solcher Knoten vorhanden ist, gibt diese Methode null
zurück.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen des untergeordneten Knotens |
namespace | Namespace | Den Namespace des untergeordneten Knotens |
Rückflug
String
: der Textwert des untergeordneten Knotens oder null
, wenn kein unmittelbarer untergeordneter Knoten vorhanden ist
durch den angegebenen Namen und Namespace
getChildren()
Ruft alle Element
-Knoten ab, die diesem Element
-Knoten unmittelbar untergeordnet sind, in der
in der sie im Dokument erscheinen.
Rückflug
Element[]
: ein Array aller Element
-Knoten, die diesem Element
-Knoten unmittelbar untergeordnet sind
getChildren(name)
Ruft alle Element
-Knoten mit dem angegebenen Namen und ohne Namespace ab, die unmittelbar untergeordnete Elemente sind
dieses Element
-Knotens in der Reihenfolge, in der sie im Dokument angezeigt werden.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen der untergeordneten Element -Knoten |
Rückflug
Element[]
– ein Array aller Element
-Knoten mit dem angegebenen Namen und ohne Namespace, die
unmittelbar untergeordnete Elemente dieses Element
-Knotens
getChildren(name, namespace)
Ruft alle Element
-Knoten mit dem angegebenen Namen und Namespace ab, die unmittelbar untergeordnete Elemente sind
und zwar in der Reihenfolge, in der sie im Dokument angezeigt werden.Element
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen der untergeordneten Element -Knoten |
namespace | Namespace | Den Namespace der untergeordneten Element -Knoten |
Rückflug
Element[]
– ein Array aller Element
-Knoten mit dem angegebenen Namen und Namespace, die
unmittelbar untergeordnete Elemente dieses Element
-Knotens
getContent(index)
Ruft den Knoten am angegebenen Index unter allen Knoten ab, die unmittelbar untergeordnete Elemente des
{@code Element}-Knotens. Wenn am angegebenen Index kein Knoten vorhanden ist, gibt diese Methode null
zurück.
Parameter
Name | Typ | Beschreibung |
---|---|---|
index | Integer | den Index für den Knoten unter allen Knoten, die unmittelbar untergeordnete Elemente des {@code-Element}-Knoten |
Rückflug
Content
: der Knoten oder null
, wenn am angegebenen Index kein Knoten vorhanden ist
getContentSize()
Ruft die Anzahl der Knoten ab, die dem {@code Element}-Knoten unmittelbar untergeordnet sind.
Rückflug
Integer
: die Anzahl der Knoten, die dem {@code Element}-Knoten unmittelbar untergeordnet sind
getDescendants()
Ruft alle Knoten, die dem {@code Element}-Knoten direkt oder indirekt untergeordnet sind, in der Reihenfolge ab, in der sie im Dokument angezeigt werden.
Rückflug
Content[]
: ein Array aller Knoten, die dem {@code Element}-Knoten direkt oder indirekt untergeordnet sind
getDocument()
Ruft das XML-Dokument ab, das den Knoten {@code Element} enthält.
Rückflug
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()
bis
das Präfix abrufen.
Rückflug
String
– Der lokale Name des Knotens Element
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 Knoten Element
ab.
Parameter
Name | Typ | Beschreibung |
---|---|---|
prefix | String | Präfix für den Namespace |
Rückflug
Namespace
– Der Namespace mit dem angegebenen Präfix für den Knoten Element
getParentElement()
getQualifiedName()
Ruft den lokalen Namen und das Namespace-Präfix des Knotens Element
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 Knotens Element
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 dem Knoten direkt oder indirekt untergeordnet sind, in der Reihenfolge, werden sie im Dokument angezeigt.
Rückflug
String
– der Textwert aller Knoten, die dem Knoten direkt oder indirekt untergeordnet sind
isAncestorOf(other)
Legt fest, ob dieser Element
-Knoten ein direktes oder indirektes übergeordnetes Element eines bestimmten Element
-Knotens ist.
Parameter
Name | Typ | Beschreibung |
---|---|---|
other | Element | den anderen Element -Knoten |
Rückflug
Boolean
: true
, wenn dieser Element
-Knoten ein direktes oder indirektes übergeordnetes Element des angegebenen
Element
Knoten; false
wenn nicht
isRootElement()
Legt fest, ob der Element
-Knoten der Stammknoten des Dokuments ist.
Rückflug
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, 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, wenn
ob ein solches Attribut existiert.
Parameter
Name | Typ | Beschreibung |
---|---|---|
attributeName | String | den 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, sofern vorhanden
wenn ein Attribut vorhanden ist.
Parameter
Name | Typ | Beschreibung |
---|---|---|
attributeName | String | den Namen des Attributs |
namespace | Namespace | den Namespace des Attributs |
Rückflug
Boolean
: true
, wenn das Attribut vorhanden war und entfernt wurde; false
wenn nicht
removeContent()
Entfernt alle Knoten, die dem {@code Element}-Knoten unmittelbar untergeordnet sind.
Rückflug
Content[]
: ein Array aller Knoten, die dem Knoten {@code Element} unmittelbar untergeordnet waren, bevor sie
wurden entfernt
removeContent(content)
Entfernt den angegebenen Knoten, wenn dieser ein unmittelbares untergeordnetes Element des {@code Element}-Knotens ist. Das Argument content
kann ein Element
-Objekt oder ein beliebiges Knotenobjekt sein, das einem
Typ in ContentType
aufgeführt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
content | Content | den zu entfernenden Knoten |
Rückflug
Boolean
: true
, wenn der Knoten ein unmittelbar untergeordnetes Element war und entfernt wurde; false
wenn nicht
removeContent(index)
Entfernt den Knoten am angegebenen Index aus allen Knoten, die unmittelbar untergeordnete Elemente des
{@code Element}-Knotens. Wenn am angegebenen Index kein Knoten vorhanden ist, gibt diese Methode null
zurück.
Parameter
Name | Typ | Beschreibung |
---|---|---|
index | Integer | den Index für den Knoten unter allen Knoten, die unmittelbar untergeordnete Elemente des {@code-Element}-Knoten |
Rückflug
Content
: der entfernte Knoten oder null
, wenn im angegebenen Index kein Knoten vorhanden ist
setAttribute(attribute)
setAttribute(name, value)
Legt das Attribut für diesen Element
-Knoten mit dem angegebenen Namen, Wert und ohne Namespace fest.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen des festzulegenden Attributs |
value | String | den Wert des festzulegenden Attributs |
Rückflug
Element
: der Element
-Knoten für 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 | den Namen des festzulegenden Attributs |
value | String | den Wert des festzulegenden Attributs |
namespace | Namespace | den Namespace des festzulegenden Attributs |
Rückflug
Element
: der Element
-Knoten für Verkettung
setName(name)
Legt den lokalen Namen des Knotens Element
fest. Um ein Namespace-Präfix für den Knoten festzulegen, verwenden Sie
setNamespace(namespace)
in Verbindung mit XmlService.getNamespace(prefix, uri)
.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | der festzulegende lokale Name |
Rückflug
Element
: der Element
-Knoten für Verkettung
setNamespace(namespace)
setText(text)
Legt den Textwert des Knotens Element
fest. Enthält der Knoten bereits einen Textwert oder
allen untergeordneten Knoten enthält, überschreibt diese Methode den alten Inhalt. 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 | den festzulegenden Text |
Rückflug
Element
: der Element
-Knoten für Verkettung