Class Format

Формат

Инструмент форматирования для вывода XML-документа, имеющий три предопределенных формата, которые можно дополнительно настроить.

// Log an XML document with specified formatting options.
const xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
const document = XmlService.parse(xml);
const output = XmlService.getCompactFormat()
                   .setLineSeparator('\n')
                   .setEncoding('UTF-8')
                   .setIndent('   ')
                   .format(document);
Logger.log(output);

Методы

Метод Тип возвращаемого значения Краткое описание
format(document) String Выводит заданный Document в виде отформатированной строки.
format(element) String Выводит заданный узел Element в виде отформатированной строки.
set Encoding(encoding) Format Задает кодировку символов, которую должен использовать форматтер.
set Indent(indent) Format Задает строку, используемую для отступа дочерних узлов относительно их родительских узлов.
set Line Separator(separator) Format Задает строку, которая будет вставляться всякий раз, когда форматтер обычно вставляет перенос строки.
set Omit Declaration(omitDeclaration) Format Определяет, следует ли форматтеру опускать XML-декларацию, например <?xml version="1.0" encoding="UTF-8"?> .
set Omit Encoding(omitEncoding) Format Определяет, следует ли форматтеру опускать кодировку в XML-декларации, например, поле кодировки в <?xml version="1.0" encoding="UTF-8"?> .

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

format(document)

Выводит заданный Document в виде отформатированной строки.

Параметры

Имя Тип Описание
document Document Документ для форматирования.

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

String — отформатированный документ.

format(element)

Выводит заданный узел Element в виде отформатированной строки.

Параметры

Имя Тип Описание
element Element Элемент для форматирования.

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

String — Отформатированный элемент.

set Encoding(encoding)

Задает кодировку символов, которую должен использовать форматтер. Аргумент encoding должен быть допустимой XML-кодировкой, например ISO-8859-1 , US-ASCII , UTF-8 или UTF-16 .

// Log an XML document with encoding that does not support certain special
// characters.
const xml = '<root><a><b>ಠ‿ಠ</b><b>ಠ‿ಠ</b></a></root>';
const document = XmlService.parse(xml);
const output =
    XmlService.getRawFormat().setEncoding('ISO-8859-1').format(document);
Logger.log(output);

Параметры

Имя Тип Описание
encoding String Кодировка для использования.

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

Format — Форматировщик для создания цепочек.

set Indent(indent)

Задает строку, используемую для отступа дочерних узлов относительно их родителей. Установка отступа, отличного от null , приведет к тому, что форматтер вставит перенос строки после каждого узла.

// Log an XML document with each child node indented four spaces.
const xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
const document = XmlService.parse(xml);
const output = XmlService.getCompactFormat().setIndent('    ').format(document);
Logger.log(output);

Параметры

Имя Тип Описание
indent String Отступ для использования.

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

Format — Форматировщик для создания цепочек.

set Line Separator(separator)

Задает строку, которая будет вставляться всякий раз, когда форматтер обычно вставляет перенос строки. Три предопределенных форматтера имеют разные условия, при которых они вставляют перенос строки. Разделитель строк по умолчанию — \r\n .

// Log an XML document with several spaces and a pipe character in place of line
// breaks.
const xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
const document = XmlService.parse(xml);
const output =
    XmlService.getRawFormat().setLineSeparator(' | ').format(document);
Logger.log(output);

Параметры

Имя Тип Описание
separator String Используемый разделитель.

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

Format — Форматировщик для создания цепочек.

set Omit Declaration(omitDeclaration)

Определяет, следует ли форматтеру опускать XML-декларацию, например <?xml version="1.0" encoding="UTF-8"?> .

Параметры

Имя Тип Описание
omit Declaration Boolean true означает пропуск XML-декларации; false — её включение.

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

Format — Форматировщик для создания цепочек.

set Omit Encoding(omitEncoding)

Определяет, следует ли форматтеру опускать кодировку в XML-декларации, например, поле кодировки в <?xml version="1.0" encoding="UTF-8"?> .

Параметры

Имя Тип Описание
omit Encoding Boolean true означает отсутствие кодировки в XML-декларации; false — её включение.

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

Format — Форматировщик для создания цепочек.