ตัวจัดรูปแบบสำหรับแสดงผลเอกสาร 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)
format(element)
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);
พารามิเตอร์
| ชื่อ | Type | คำอธิบาย |
|---|---|---|
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);
พารามิเตอร์
| ชื่อ | Type | คำอธิบาย |
|---|---|---|
indent | String | การเยื้องเพื่อใช้ |
รีเทิร์น
Format — ตัวจัดรูปแบบสำหรับการทำเชน
setLineSeparator(separator)
ตั้งค่าสตริงที่จะแทรกทุกครั้งที่ตัวจัดรูปแบบมักจะแทรกตัวแบ่งบรรทัด ตัวจัดรูปแบบ 3 ตัวที่กำหนดไว้ล่วงหน้ามีเงื่อนไขในการแทรกตัวแบ่งบรรทัดแตกต่างกัน โดยตัวคั่นบรรทัดเริ่มต้นคือ \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);
พารามิเตอร์
| ชื่อ | Type | คำอธิบาย |
|---|---|---|
separator | String | ตัวคั่นที่จะใช้ |
รีเทิร์น
Format — ตัวจัดรูปแบบสำหรับการทำเชน
setOmitDeclaration(omitDeclaration)
ตั้งค่าว่าตัวจัดรูปแบบควรข้ามการประกาศ XML หรือไม่ เช่น <?xml version="1.0"
encoding="UTF-8"?>
พารามิเตอร์
| ชื่อ | Type | คำอธิบาย |
|---|---|---|
omitDeclaration | Boolean | true เพื่อยกเว้นการประกาศ XML falseหากต้องการรวมการประกาศ |
รีเทิร์น
Format — ตัวจัดรูปแบบสำหรับการทำเชน
setOmitEncoding(omitEncoding)
ตั้งค่าว่าตัวจัดรูปแบบควรละเว้นการเข้ารหัสในการประกาศ XML หรือไม่ เช่น ช่องการเข้ารหัสใน <?xml version="1.0" encoding="UTF-8"?>
พารามิเตอร์
| ชื่อ | Type | คำอธิบาย |
|---|---|---|
omitEncoding | Boolean | true เพื่อละเว้นการเข้ารหัสในการประกาศ XML ใช้ false เพื่อรวมการเข้ารหัส |
รีเทิร์น
Format — ตัวจัดรูปแบบสำหรับการทำเชน