Class Element

Элемент

Изображение узла XML- Element .

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

Методы

Метод Тип возвращаемого значения Краткое описание
add Content(content) Element Добавляет указанный узел в качестве последнего дочернего элемента узла Element .
add Content(index, content) Element Вставляет заданный узел по заданному индексу среди всех узлов, являющихся непосредственными дочерними элементами узла Element .
clone Content() Content[] Создает неприкрепленные копии всех узлов, являющихся непосредственными дочерними элементами узла {@code Element}.
detach() Content |null Отсоединяет узел от родительского узла Element .
get All Content() Content[] Получает все узлы, являющиеся непосредственными дочерними элементами узла {@code Element}.
get Attribute(name) Attribute |null Получает атрибут для этого узла Element с заданным именем и без пространства имен.
get Attribute(name, namespace) Attribute |null Получает атрибут для данного узла Element с заданным именем и пространством имен.
get Attributes() Attribute[] Получает все атрибуты для данного узла Element в том порядке, в котором они указаны в документе.
get Child(name) Element |null Получает первый узел Element с заданным именем и без пространства имен, который является непосредственным дочерним узлом этого узла Element .
get Child(name, namespace) Element |null Получает первый узел Element с заданным именем и пространством имен, который является непосредственным дочерним элементом этого узла Element .
get Child Text(name) String|null Получает текстовое значение узла с заданным именем и без пространства имен, если узел является непосредственным дочерним элементом узла Element .
get Child Text(name, namespace) String|null Получает текстовое значение узла с заданным именем и пространством имен, если узел является непосредственным дочерним элементом узла Element .
get Children() Element[] Получает все узлы Element , являющиеся непосредственными дочерними элементами данного узла Element , в том порядке, в котором они расположены в документе.
get Children(name) Element[] Получает все узлы Element с заданным именем и без пространства имен, являющиеся непосредственными дочерними элементами этого узла Element , в том порядке, в котором они отображаются в документе.
get Children(name, namespace) Element[] Получает все узлы Element с заданным именем и пространством имен, являющиеся непосредственными дочерними элементами этого узла Element , в том порядке, в котором они расположены в документе.
get Content(index) Content |null Получает узел с заданным индексом среди всех узлов, являющихся непосредственными дочерними элементами узла {@code Element}.
get Content Size() Integer Получает количество узлов, являющихся непосредственными дочерними элементами узла {@code Element}.
get Descendants() Content[] Получает все узлы, являющиеся прямыми или косвенными дочерними элементами узла {@code Element}, в том порядке, в котором они отображаются в документе.
get Document() Document Получает XML-документ, содержащий узел {@code Element}.
get Name() String Получает локальное имя узла Element .
get Namespace() Namespace Получает пространство имен для узла Element .
get Namespace(prefix) Namespace Получает пространство имен с заданным префиксом для узла Element .
get Parent Element() Element |null Получает родительский Element .
get Qualified Name() String Получает локальное имя и префикс пространства имен узла Element в формате [namespacePrefix]:[localName] .
get Text() String Получает текстовое значение узла Element .
get Value() String Получает текстовые значения всех узлов, являющихся прямыми или косвенными дочерними узлами данного узла, в том порядке, в котором они появляются в документе.
is Ancestor Of(other) Boolean Определяет, является ли данный узел Element прямым или косвенным родителем данного узла Element .
is Root Element() Boolean Определяет, является ли узел Element корневым узлом документа.
remove Attribute(attribute) Boolean Удаляет указанный атрибут для данного узла Element , если такой атрибут существует.
remove Attribute(attributeName) Boolean Удаляет атрибут для данного узла Element с заданным именем и без пространства имен, если такой атрибут существует.
remove Attribute(attributeName, namespace) Boolean Удаляет атрибут для данного узла Element с заданным именем и пространством имен, если такой атрибут существует.
remove Content() Content[] Удаляет все узлы, являющиеся непосредственными дочерними элементами узла {@code Element}.
remove Content(content) Boolean Удаляет указанный узел, если он является непосредственным дочерним элементом узла {@code Element}.
remove Content(index) Content |null Удаляет узел с заданным индексом среди всех узлов, являющихся непосредственными дочерними элементами узла {@code Element}.
set Attribute(attribute) Element Устанавливает заданный атрибут для данного узла Element .
set Attribute(name, value) Element Устанавливает атрибут для этого узла Element с заданным именем, значением и без указания пространства имен.
set Attribute(name, value, namespace) Element Устанавливает атрибут для этого узла Element с заданным именем, значением и пространством имен.
set Name(name) Element Задает локальное имя узла Element .
set Namespace(namespace) Element Задает пространство имен для узла Element .
set Text(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 |null — Отсоединенный узел.

getAllContent()

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

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

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

getAttribute(name)

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

Параметры

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

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

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

getAttribute(name, namespace)

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

Параметры

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

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

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

getAttributes()

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

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

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

getChild(name)

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

Параметры

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

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

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

getChild(name, namespace)

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

Параметры

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

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

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

getChildText(name)

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

Параметры

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

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

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

getChildText(name, namespace)

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

Параметры

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

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

String|null — текстовое значение дочернего узла или 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 — Узел, или 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 |null — Родительский узел Element .

getQualifiedName()

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

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

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

getText()

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

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

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

getValue()

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

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

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

isAncestorOf(other)

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

Параметры

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

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

Boolean — true , если данный узел Element является прямым или косвенным родителем заданного узла Element ; false в противном случае.

isRootElement()

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

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

Boolean — true , если узел Element является корневым узлом документа; false в противном случае.

removeAttribute(attribute)

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

Параметры

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

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

Boolean — true если атрибут существовал и был удален; false , если нет.

removeAttribute(attributeName)

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

Параметры

Имя Тип Описание
attribute Name String Название атрибута.

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

Boolean — true если атрибут существовал и был удален; false , если нет.

removeAttribute(attributeName, namespace)

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

Параметры

Имя Тип Описание
attribute Name String Название атрибута.
namespace Namespace Пространство имен атрибута.

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

Boolean — true если атрибут существовал и был удален; false , если нет.

removeContent()

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

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

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

removeContent(content)

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

Параметры

Имя Тип Описание
content Content Узел, который нужно удалить.

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

Boolean — true если узел являлся непосредственным дочерним узлом и был удален; false , если нет.

removeContent(index)

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

Параметры

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

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

Content |null — Удаленный узел или 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 для создания цепочек.