Class Format

รูปแบบ

ตัวจัดรูปแบบสำหรับเอาต์พุตเอกสาร XML โดยมีรูปแบบที่กำหนดไว้ล่วงหน้า 3 รูปแบบซึ่งปรับแต่งเพิ่มเติมได้

// 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 ที่ระบุเป็นสตริงที่จัดรูปแบบแล้ว
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 ที่ระบุเป็นสตริงที่จัดรูปแบบ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
documentDocumentเอกสารที่จะจัดรูปแบบ

รีเทิร์น

String — เอกสารที่จัดรูปแบบแล้ว


format(element)

แสดงผลโหนด Element ที่ระบุเป็นสตริงที่จัดรูปแบบแล้ว

พารามิเตอร์

ชื่อประเภทคำอธิบาย
elementElementองค์ประกอบที่จะจัดรูปแบบ

รีเทิร์น

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.
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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
encodingStringการเข้ารหัสที่จะใช้

รีเทิร์น

Format — ตัวจัดรูปแบบสำหรับการเชื่อมโยง


setIndent(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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
indentStringการเยื้องที่จะใช้

รีเทิร์น

Format — ตัวจัดรูปแบบสำหรับการเชื่อมโยง


setLineSeparator(separator)

ตั้งค่าสตริงที่จะแทรกเมื่อใดก็ตามที่โปรแกรมจัดรูปแบบจะแทรกตัวแบ่งบรรทัดตามปกติ ตัวจัดรูปแบบที่กำหนดไว้ล่วงหน้า 3 รายการมีเงื่อนไขที่แตกต่างกันในการแทรกการขึ้นบรรทัดใหม่ ตัวคั่นบรรทัดเริ่มต้นคือ \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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
separatorStringตัวคั่นที่จะใช้

รีเทิร์น

Format — ตัวจัดรูปแบบสำหรับการเชื่อมโยง


setOmitDeclaration(omitDeclaration)

กำหนดว่าตัวจัดรูปแบบควรละเว้นการประกาศ XML หรือไม่ เช่น <?xml version="1.0" encoding="UTF-8"?>

พารามิเตอร์

ชื่อประเภทคำอธิบาย
omitDeclarationBooleantrue เพื่อละเว้นการประกาศ XML false เพื่อรวมการประกาศ XML

รีเทิร์น

Format — ตัวจัดรูปแบบสำหรับการเชื่อมโยง


setOmitEncoding(omitEncoding)

กำหนดว่าตัวจัดรูปแบบควรละเว้นการเข้ารหัสในการประกาศ XML หรือไม่ เช่น ฟิลด์การเข้ารหัสใน <?xml version="1.0" encoding="UTF-8"?>

พารามิเตอร์

ชื่อประเภทคำอธิบาย
omitEncodingBooleantrue เพื่อละเว้นการเข้ารหัสในการประกาศ XML false เพื่อรวมการเข้ารหัส

รีเทิร์น

Format — ตัวจัดรูปแบบสำหรับการเชื่อมโยง