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：用於鏈結的格式設定工具