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

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

ตั้งค่าสตริงให้แทรกเมื่อโดยปกติแล้วตัวจัดรูปแบบจะแทรกตัวแบ่งบรรทัด องค์ประกอบ 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);

พารามิเตอร์

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