หน้านี้ได้รับการแปลโดย Cloud Translation API

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`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.
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);

พารามิเตอร์

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

รีเทิร์น

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

พารามิเตอร์

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

รีเทิร์น

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`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 — ตัวจัดรูปแบบสำหรับใช้ต่อเชื่อม