Эта страница переведена с помощью Cloud Translation API.

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 — форматировщик для цепочки