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 - 格式设置工具，用于链接