Class Element

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Элемент

Представление узла Element XML.

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

Методы

Метод Тип возврата Краткое описание
addContent(content) Element Добавляет данный узел в качестве последнего дочернего элемента узла Element .
addContent(index, content) Element Вставляет данный узел с заданным индексом среди всех узлов, которые являются непосредственными дочерними элементами узла Element .
cloneContent() Content[] Создает неприкрепленные копии всех узлов, которые являются непосредственными дочерними элементами узла {@code Element}.
detach() Content Отсоединяет узел от его родительского узла Element .
getAllContent() Content[] Получает все узлы, которые являются непосредственными дочерними элементами узла {@code Element}.
getAttribute(name) Attribute Получает атрибут для этого узла Element с заданным именем и без пространства имен.
getAttribute(name, namespace) Attribute Получает атрибут для этого узла Element с заданным именем и пространством имен.
getAttributes() Attribute[] Получает все атрибуты для этого узла Element в том порядке, в котором они появляются в документе.
getChild(name) Element Получает первый узел Element с заданным именем и без пространства имен, который является непосредственным дочерним элементом этого узла Element .
getChild(name, namespace) Element Получает первый узел Element с заданным именем и пространством имен, который является непосредственным дочерним элементом этого узла Element .
getChildText(name) String Получает текстовое значение узла с заданным именем и без пространства имен, если узел является непосредственным дочерним элементом узла Element .
getChildText(name, namespace) String Получает текстовое значение узла с заданным именем и пространством имен, если узел является непосредственным дочерним элементом узла Element .
getChildren() Element[] Получает все узлы Element , которые являются непосредственными дочерними элементами этого узла Element , в том порядке, в котором они появляются в документе.
getChildren(name) Element[] Получает все узлы Element с заданным именем и без пространства имен, которые являются непосредственными дочерними элементами этого узла Element , в порядке их появления в документе.
getChildren(name, namespace) Element[] Получает все узлы Element с заданным именем и пространством имен, которые являются непосредственными дочерними элементами этого узла Element , в порядке их появления в документе.
getContent(index) Content Получает узел с заданным индексом среди всех узлов, которые являются непосредственными дочерними элементами узла {@code Element}.
getContentSize() Integer Получает количество узлов, которые являются непосредственными дочерними элементами узла {@code Element}.
getDescendants() Content[] Получает все узлы, являющиеся прямыми или косвенными дочерними элементами узла {@code Element}, в порядке их появления в документе.
getDocument() Document Получает XML-документ, содержащий узел {@code Element}.
getName() String Получает локальное имя узла Element .
getNamespace() Namespace Получает пространство имен для узла Element .
getNamespace(prefix) Namespace Получает пространство имен с заданным префиксом для узла Element .
getParentElement() Element Получает родительский узел Element узла.
getQualifiedName() String Получает локальное имя и префикс пространства имен узла Element в форме [namespacePrefix]:[localName] .
getText() String Получает текстовое значение узла Element .
getValue() String Получает текстовое значение всех узлов, которые являются прямыми или косвенными дочерними узлами узла, в порядке их появления в документе.
isAncestorOf(other) Boolean Определяет, является ли этот узел Element прямым или косвенным родителем данного узла Element .
isRootElement() Boolean Определяет, является ли узел Element корневым узлом документа.
removeAttribute(attribute) Boolean Удаляет данный атрибут для этого узла Element , если такой атрибут существует.
removeAttribute(attributeName) Boolean Удаляет атрибут для этого узла Element с заданным именем и без пространства имен, если такой атрибут существует.
removeAttribute(attributeName, namespace) Boolean Удаляет атрибут для этого узла Element с заданным именем и пространством имен, если такой атрибут существует.
removeContent() Content[] Удаляет все узлы, которые являются непосредственными дочерними элементами узла {@code Element}.
removeContent(content) Boolean Удаляет данный узел, если он является непосредственным дочерним элементом узла {@code Element}.
removeContent(index) Content Удаляет узел с заданным индексом среди всех узлов, которые являются непосредственными дочерними элементами узла {@code Element}.
setAttribute(attribute) Element Устанавливает данный атрибут для этого узла Element .
setAttribute(name, value) Element Задает атрибут для этого узла Element с заданным именем, значением и без пространства имен.
setAttribute(name, value, namespace) Element Задает атрибут для этого узла Element с заданным именем, значением и пространством имен.
setName(name) Element Задает локальное имя узла Element .
setNamespace(namespace) Element Задает пространство имен для узла Element .
setText(text) Element Задает текстовое значение узла Element .

Подробная документация

addContent(content)

Добавляет данный узел в качестве последнего дочернего элемента узла Element . Аргумент content может быть объектом Element или любым объектом узла, который соответствует типу, указанному в ContentType .

Параметры

Имя Тип Описание
content Content узел для добавления

Возвращаться

Element — узел Element , для цепочки


addContent(index, content)

Вставляет данный узел с заданным индексом среди всех узлов, которые являются непосредственными дочерними элементами узла Element . Аргумент content может быть объектом Element или любым объектом узла, который соответствует типу, указанному в ContentType .

Параметры

Имя Тип Описание
index Integer индекс, по которому нужно вставить узел среди всех узлов, которые являются непосредственными дочерними Element узла элемента
content Content узел для вставки

Возвращаться

Element — узел Element , для цепочки


cloneContent()

Создает неприкрепленные копии всех узлов, которые являются непосредственными дочерними элементами узла {@code Element}.

Возвращаться

Content[] — массив неприсоединенных копий всех узлов, которые являются непосредственными дочерними элементами узла {@code Element}.


detach()

Отсоединяет узел от его родительского узла Element . Если у узла нет родителя, этот метод не действует.

Возвращаться

Content — отсоединенный узел


getAllContent()

Получает все узлы, которые являются непосредственными дочерними элементами узла {@code Element}.

Возвращаться

Content[] — массив всех узлов, которые являются непосредственными дочерними элементами узла {@code Element}.


getAttribute(name)

Получает атрибут для этого узла Element с заданным именем и без пространства имен. Если такого атрибута нет, этот метод возвращает null .

Параметры

Имя Тип Описание
name String имя атрибута

Возвращаться

Attribute — атрибут или null , если нет ни атрибута с заданным именем, ни пространства имен.


getAttribute(name, namespace)

Получает атрибут для этого узла Element с заданным именем и пространством имен. Если такого узла нет, этот метод возвращает null .

Параметры

Имя Тип Описание
name String имя атрибута
namespace Namespace пространство имен атрибута

Возвращаться

Attribute — атрибут или null , если нет атрибута с заданным именем и пространством имен.


getAttributes()

Получает все атрибуты для этого узла Element в том порядке, в котором они появляются в документе.

Возвращаться

Attribute[] — массив всех атрибутов для этого узла Element


getChild(name)

Получает первый узел Element с заданным именем и без пространства имен, который является непосредственным дочерним элементом этого узла Element . Если такого узла нет, этот метод возвращает null .

Параметры

Имя Тип Описание
name String имя дочернего узла Element

Возвращаться

Element — узел Element или null , если нет непосредственного дочернего узла Element с заданным именем и пространством имен.


getChild(name, namespace)

Получает первый узел Element с заданным именем и пространством имен, который является непосредственным дочерним элементом этого узла Element . Если такого узла нет, этот метод возвращает null .

Параметры

Имя Тип Описание
name String имя дочернего узла Element
namespace Namespace пространство имен дочернего узла Element

Возвращаться

Element — узел Element или null , если нет непосредственного дочернего узла Element с заданным именем и пространством имен.


getChildText(name)

Получает текстовое значение узла с заданным именем и без пространства имен, если узел является непосредственным дочерним элементом узла Element . Если такого узла нет, этот метод возвращает null .

Параметры

Имя Тип Описание
name String имя дочернего узла

Возвращаться

String — текстовое значение дочернего узла или null , если нет непосредственного дочернего узла с заданным именем и пространством имен.


getChildText(name, namespace)

Получает текстовое значение узла с заданным именем и пространством имен, если узел является непосредственным дочерним элементом узла Element . Если такого узла нет, этот метод возвращает null .

Параметры

Имя Тип Описание
name String имя дочернего узла
namespace Namespace пространство имен дочернего узла

Возвращаться

String — текстовое значение дочернего узла или null , если нет непосредственного дочернего узла с заданным именем и пространством имен.


getChildren()

Получает все узлы Element , которые являются непосредственными дочерними элементами этого узла Element , в том порядке, в котором они появляются в документе.

Возвращаться

Element[] — массив всех узлов Element , которые являются непосредственными дочерними элементами этого узла Element .


getChildren(name)

Получает все узлы Element с заданным именем и без пространства имен, которые являются непосредственными дочерними элементами этого узла Element , в порядке их появления в документе.

Параметры

Имя Тип Описание
name String имя дочерних узлов Element

Возвращаться

Element[] — массив всех узлов Element с заданным именем и без пространства имен, которые являются непосредственными дочерними элементами этого узла Element .


getChildren(name, namespace)

Получает все узлы Element с заданным именем и пространством имен, которые являются непосредственными дочерними элементами этого узла Element , в порядке их появления в документе.

Параметры

Имя Тип Описание
name String имя дочерних узлов Element
namespace Namespace пространство имен дочерних узлов Element

Возвращаться

Element[] — массив всех узлов Element с заданным именем и пространством имен, которые являются непосредственными дочерними элементами этого узла Element .


getContent(index)

Получает узел с заданным индексом среди всех узлов, которые являются непосредственными дочерними элементами узла {@code Element}. Если по данному индексу нет узла, этот метод возвращает null .

Параметры

Имя Тип Описание
index Integer индекс узла среди всех узлов, которые являются непосредственными дочерними элементами узла {@code Element}

Возвращаться

Content — узел или null , если по данному индексу узла нет.


getContentSize()

Получает количество узлов, которые являются непосредственными дочерними элементами узла {@code Element}.

Возвращаться

Integer число — количество узлов, которые являются непосредственными дочерними элементами узла {@code Element}.


getDescendants()

Получает все узлы, являющиеся прямыми или косвенными дочерними элементами узла {@code Element}, в порядке их появления в документе.

Возвращаться

Content[] — массив всех узлов, которые являются прямыми или косвенными дочерними элементами узла {@code Element}.


getDocument()

Получает XML-документ, содержащий узел {@code Element}.

Возвращаться

Document — документ, содержащий узел {@code Element}.


getName()

Получает локальное имя узла Element . Если узел имеет префикс пространства имен, используйте getQualifiedName() или getNamespace() . getPrefix() для получения префикса.

Возвращаться

String — локальное имя узла Element .


getNamespace()

Получает пространство имен для узла Element .

Возвращаться

Namespace — пространство имен для узла Element .


getNamespace(prefix)

Получает пространство имен с заданным префиксом для узла Element .

Параметры

Имя Тип Описание
prefix String префикс для пространства имен

Возвращаться

Namespace — пространство имен с заданным префиксом для узла Element .


getParentElement()

Получает родительский узел Element узла. Если у узла нет родителя, этот метод возвращает null .

Возвращаться

Element — родительский узел Element


getQualifiedName()

Получает локальное имя и префикс пространства имен узла Element в форме [namespacePrefix]:[localName] . Если узел не имеет префикса пространства имен, используйте getName() .

Возвращаться

String — локальное имя и префикс пространства имен узла Element в виде [namespacePrefix]:[localName]


getText()

Получает текстовое значение узла Element .

Возвращаться

String — текстовое значение узла Element .


getValue()

Получает текстовое значение всех узлов, которые являются прямыми или косвенными дочерними узлами узла, в порядке их появления в документе.

Возвращаться

String — текстовое значение всех узлов, которые являются прямыми или косвенными дочерними элементами узла.


isAncestorOf(other)

Определяет, является ли этот узел Element прямым или косвенным родителем данного узла Element .

Параметры

Имя Тип Описание
other Element другой узел Element

Возвращаться

Booleantrue , если этот узел Element является прямым или косвенным родителем данного узла Element ; false , если нет


isRootElement()

Определяет, является ли узел Element корневым узлом документа.

Возвращаться

Booleantrue , если узел Element является корневым узлом документа; false , если нет


removeAttribute(attribute)

Удаляет данный атрибут для этого узла Element , если такой атрибут существует.

Параметры

Имя Тип Описание
attribute Attribute атрибут

Возвращаться

Booleantrue , если атрибут существовал и был удален; false , если нет


removeAttribute(attributeName)

Удаляет атрибут для этого узла Element с заданным именем и без пространства имен, если такой атрибут существует.

Параметры

Имя Тип Описание
attributeName String имя атрибута

Возвращаться

Booleantrue , если атрибут существовал и был удален; false , если нет


removeAttribute(attributeName, namespace)

Удаляет атрибут для этого узла Element с заданным именем и пространством имен, если такой атрибут существует.

Параметры

Имя Тип Описание
attributeName String имя атрибута
namespace Namespace пространство имен атрибута

Возвращаться

Booleantrue , если атрибут существовал и был удален; false , если нет


removeContent()

Удаляет все узлы, которые являются непосредственными дочерними элементами узла {@code Element}.

Возвращаться

Content[] — массив всех узлов, которые были непосредственными дочерними элементами узла {@code Element} до их удаления.


removeContent(content)

Удаляет данный узел, если он является непосредственным дочерним элементом узла {@code Element}. Аргумент content может быть объектом Element или любым объектом узла, который соответствует типу, указанному в ContentType .

Параметры

Имя Тип Описание
content Content узел для удаления

Возвращаться

Booleantrue , если узел был непосредственным потомком и был удален; false , если нет


removeContent(index)

Удаляет узел с заданным индексом среди всех узлов, которые являются непосредственными дочерними элементами узла {@code Element}. Если по данному индексу нет узла, этот метод возвращает null .

Параметры

Имя Тип Описание
index Integer индекс узла среди всех узлов, которые являются непосредственными дочерними элементами узла {@code Element}

Возвращаться

Content — узел, который был удален, или null , если по данному индексу узла нет.


setAttribute(attribute)

Устанавливает данный атрибут для этого узла Element .

Параметры

Имя Тип Описание
attribute Attribute атрибут для установки

Возвращаться

Element — узел Element , для цепочки


setAttribute(name, value)

Задает атрибут для этого узла Element с заданным именем, значением и без пространства имен.

Параметры

Имя Тип Описание
name String имя атрибута для установки
value String значение атрибута для установки

Возвращаться

Element — узел Element , для цепочки


setAttribute(name, value, namespace)

Задает атрибут для этого узла Element с заданным именем, значением и пространством имен.

Параметры

Имя Тип Описание
name String имя атрибута для установки
value String значение атрибута для установки
namespace Namespace пространство имен атрибута для установки

Возвращаться

Element — узел Element , для цепочки


setName(name)

Задает локальное имя узла Element . Чтобы задать префикс пространства имен для узла, используйте setNamespace(namespace) в сочетании с XmlService.getNamespace(prefix, uri) .

Параметры

Имя Тип Описание
name String локальное имя для установки

Возвращаться

Element — узел Element , для цепочки


setNamespace(namespace)

Задает пространство имен для узла Element .

Параметры

Имя Тип Описание
namespace Namespace пространство имен для установки

Возвращаться

Element — узел Element , для цепочки


setText(text)

Задает текстовое значение узла Element . Если узел уже содержит текстовое значение или любые дочерние узлы, этот метод перезаписывает старое содержимое. Вместо этого, чтобы добавить или вставить содержимое, используйте addContent(content) или addContent(index, content) .

Параметры

Имя Тип Описание
text String текст для установки

Возвращаться

Element — узел Element , для цепочки