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

Class Format

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

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

Методы

Метод	Тип возврата	Краткое описание
`format(document)`	`String`	Выводит данный `Document` в виде форматированной строки.
`format(element)`	`String`	Выводит данный узел `Element` в виде форматированной строки.
`setEncoding(encoding)`	`Format`	Устанавливает кодировку символов, которую должен использовать форматтер.
`setIndent(indent)`	`Format`	Устанавливает строку, используемую для отступа дочерних узлов относительно их родителей.
`setLineSeparator(separator)`	`Format`	Устанавливает строку для вставки всякий раз, когда форматтер обычно вставляет разрыв строки.
`setOmitDeclaration(omitDeclaration)`	`Format`	Устанавливает, должен ли форматировщик пропускать объявление XML, например `<?xml version="1.0" encoding="UTF-8"?>` .
`setOmitEncoding(omitEncoding)`	`Format`	Устанавливает, должен ли форматировщик пропускать кодировку в объявлении XML, например поле кодировки в `<?xml version="1.0" encoding="UTF-8"?>` .

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

`format(document)`

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

Параметры

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

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

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

`format(element)`

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

Параметры

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

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

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

`setEncoding(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.
var xml = '<root><a><b>ಠ‿ಠ</b><b>ಠ‿ಠ</b></a></root>';
var document = XmlService.parse(xml);
var output = XmlService.getRawFormat()
    .setEncoding('ISO-8859-1')
    .format(document);
Logger.log(output);

Параметры

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

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

Format — форматтер для связывания

`setIndent(indent)`

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

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

Параметры

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

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

Format — форматтер для связывания

`setLineSeparator(separator)`

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

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

Параметры

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

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

Format — форматтер для связывания

`setOmitDeclaration(omitDeclaration)`

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

Параметры

Имя	Тип	Описание
`omitDeclaration`	`Boolean`	`true` , чтобы опустить объявление XML; `false` включать его

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

Format — форматтер для связывания

`setOmitEncoding(omitEncoding)`

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

Параметры

Имя	Тип	Описание
`omitEncoding`	`Boolean`	`true` , чтобы опустить кодировку в объявлении XML; `false` включать его

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

Format — форматтер для связывания