Class Element

Элемент

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

// 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 Отсоединяет узел от его родительского узла Element .
get All Content() Content[] Получает все узлы, которые являются непосредственными дочерними элементами узла {@code Element}.
get Attribute(name) Attribute Получает атрибут для этого узла Element с заданным именем и без пространства имен.
get Attribute(name, namespace) Attribute Получает атрибут для этого узла Element с заданным именем и пространством имен.
get Attributes() Attribute[] Получает все атрибуты для этого узла Element в том порядке, в котором они появляются в документе.
get Child(name) Element Получает первый узел Element с заданным именем и без пространства имен, который является непосредственным дочерним элементом этого узла Element .
get Child(name, namespace) Element Получает первый узел Element с заданным именем и пространством имен, который является непосредственным дочерним элементом этого узла Element .
get Child Text(name) String Получает текстовое значение узла с заданным именем и без пространства имен, если узел является непосредственным дочерним элементом узла Element .
get Child Text(name, namespace) String Получает текстовое значение узла с заданным именем и пространством имен, если узел является непосредственным дочерним элементом узла Element .
get Children() Element[] Получает все узлы Element , которые являются непосредственными дочерними элементами этого узла Element , в том порядке, в котором они появляются в документе.
get Children(name) Element[] Получает все узлы Element с заданным именем и без пространства имен, которые являются непосредственными дочерними элементами этого узла Element , в том порядке, в котором они появляются в документе.
get Children(name, namespace) Element[] Получает все узлы Element с заданным именем и пространством имен, которые являются непосредственными дочерними элементами этого узла Element , в том порядке, в котором они появляются в документе.
get Content(index) Content Получает узел по заданному индексу среди всех узлов, которые являются непосредственными дочерними элементами узла {@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 Получает родительский узел 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 Удаляет узел по заданному индексу среди всех узлов, которые являются непосредственными дочерними элементами узла {@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 .

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

add Content(content)

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

Параметры

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

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

Element — узел Element для объединения в цепочку.

add Content(index, content)

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

Параметры

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

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

Element — узел Element для объединения в цепочку.

clone Content()

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

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

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

detach()

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

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

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

get All Content()

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

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

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

get Attribute(name)

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

Параметры

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

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

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

get Attribute(name, namespace)

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

Параметры

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

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

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

get Attributes()

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

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

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

get Child(name)

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

Параметры

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

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

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

get Child(name, namespace)

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

Параметры

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

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

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

get Child Text(name)

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

Параметры

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

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

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

get Child Text(name, namespace)

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

Параметры

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

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

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

get Children()

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

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

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

get Children(name)

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

Параметры

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

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

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

get Children(name, namespace)

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

Параметры

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

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

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

get Content(index)

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

Параметры

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

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

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

get Content Size()

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

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

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

get Descendants()

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

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

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

get Document()

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

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

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

get Name()

Получает локальное имя узла Element . Если узел имеет префикс пространства имен, используйте get Qualified Name() или get Namespace() . get Prefix() чтобы получить префикс.

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

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

get Namespace()

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

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

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

get Namespace(prefix)

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

Параметры

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

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

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

get Parent Element()

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

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

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

get Qualified Name()

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

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

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

get Text()

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

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

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

get Value()

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

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

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

is Ancestor Of(other)

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

Параметры

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

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

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

is Root Element()

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

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

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

remove Attribute(attribute)

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

Параметры

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

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

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

remove Attribute(attributeName)

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

Параметры

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

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

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

remove Attribute(attributeName, namespace)

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

Параметры

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

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

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

remove Content()

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

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

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

remove Content(content)

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

Параметры

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

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

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

remove Content(index)

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

Параметры

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

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

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

set Attribute(attribute)

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

Параметры

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

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

Element — узел Element для объединения в цепочку.

set Attribute(name, value)

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

Параметры

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

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

Element — узел Element для объединения в цепочку.

set Attribute(name, value, namespace)

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

Параметры

Имя Тип Описание
name String имя атрибута, который нужно установить
value String значение атрибута, который нужно установить
namespace Namespace пространство имен атрибута, который нужно установить

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

Element — узел Element для объединения в цепочку.

set Name(name)

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

Параметры

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

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

Element — узел Element для объединения в цепочку.

set Namespace(namespace)

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

Параметры

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

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

Element — узел Element для объединения в цепочку.

set Text(text)

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

Параметры

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

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

Element — узел Element для объединения в цепочку.