Class Format

Format

Formatter untuk menampilkan dokumen XML, dengan tiga format standar yang dapat disesuaikan lebih lanjut.

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

Metode

Metode	Jenis nilai yang ditampilkan	Deskripsi singkat
format(document)	String	Menampilkan Document yang diberikan sebagai string yang diformat.
format(element)	String	Menampilkan node Element yang diberikan sebagai string yang diformat.
setEncoding(encoding)	Format	Menetapkan encoding karakter yang harus digunakan pemformat.
setIndent(indent)	Format	Menetapkan string yang digunakan untuk mengindentasi node turunan relatif terhadap induknya.
setLineSeparator(separator)	Format	Menetapkan string yang akan disisipkan setiap kali pemformat biasanya menyisipkan jeda baris.
setOmitDeclaration(omitDeclaration)	Format	Menetapkan apakah pemformat harus menghapus deklarasi XML, seperti <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)	Format	Menetapkan apakah pemformat harus menghilangkan encoding dalam deklarasi XML, seperti kolom encoding di <?xml version="1.0" encoding="UTF-8"?>.

Dokumentasi mendetail

format(document)

Menampilkan Document yang diberikan sebagai string yang diformat.

Parameter

Nama	Jenis	Deskripsi
document	Document	Dokumen yang akan diformat.

Pulang pergi

String — Dokumen yang diformat.

---

format(element)

Menampilkan node Element yang diberikan sebagai string yang diformat.

Parameter

Nama	Jenis	Deskripsi
element	Element	Elemen yang akan diformat.

Pulang pergi

String — Elemen yang diformat.

---

setEncoding(encoding)

Menetapkan encoding karakter yang harus digunakan pemformat. Argumen encoding harus berupa encoding XML yang diterima seperti ISO-8859-1, US-ASCII, UTF-8, atau 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);

Parameter

Nama	Jenis	Deskripsi
encoding	String	Encoding yang akan digunakan.

Pulang pergi

Format — Pemformat, untuk dirangkaikan.

---

setIndent(indent)

Menetapkan string yang digunakan untuk mengindentasi node turunan relatif terhadap induknya. Menetapkan indentasi selain null akan menyebabkan pemformat menyisipkan jeda baris setelah setiap node.

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

Parameter

Nama	Jenis	Deskripsi
indent	String	Indentasi yang akan digunakan.

Pulang pergi

Format — Pemformat, untuk dirangkaikan.

---

setLineSeparator(separator)

Menetapkan string yang akan disisipkan setiap kali pemformat biasanya menyisipkan jeda baris. Tiga pemformat yang telah ditentukan sebelumnya memiliki kondisi berbeda saat menyisipkan jeda baris. Pemisah baris default adalah \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);

Parameter

Nama	Jenis	Deskripsi
separator	String	Pemisah yang akan digunakan.

Pulang pergi

Format — Pemformat, untuk dirangkaikan.

---

setOmitDeclaration(omitDeclaration)

Menetapkan apakah pemformat harus menghapus deklarasi XML, seperti <?xml version="1.0" encoding="UTF-8"?>.

Parameter

Nama	Jenis	Deskripsi
omitDeclaration	Boolean	true untuk menghilangkan deklarasi XML; false untuk menyertakannya.

Pulang pergi

Format — Pemformat, untuk dirangkaikan.

---

setOmitEncoding(omitEncoding)

Menetapkan apakah pemformat harus menghilangkan encoding dalam deklarasi XML, seperti kolom encoding di <?xml version="1.0" encoding="UTF-8"?>.

Parameter

Nama	Jenis	Deskripsi
omitEncoding	Boolean	true untuk menghilangkan encoding dalam deklarasi XML; false untuk menyertakannya.

Pulang pergi

Format — Pemformat, untuk dirangkaikan.