Halaman ini diterjemahkan oleh Cloud Translation API.

Class Format

Formator untuk menghasilkan 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 hasil yang ditampilkan	Deskripsi singkat
`format(document)`	`String`	Menghasilkan `Document` yang diberikan sebagai string berformat.
`format(element)`	`String`	Menghasilkan node `Element` yang diberikan sebagai string berformat.
`setEncoding(encoding)`	`Format`	Menetapkan encoding karakter yang harus digunakan oleh pemformat.
`setIndent(indent)`	`Format`	Menetapkan string yang digunakan untuk membuat indentasi node turunan relatif terhadap induknya.
`setLineSeparator(separator)`	`Format`	Menetapkan string yang akan disisipkan setiap kali pemformat biasanya menyisipkan baris baru.
`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 menghapus encoding dalam deklarasi XML, seperti kolom encoding di `<?xml version="1.0" encoding="UTF-8"?>`.

Dokumentasi mendetail

`format(document)`

Menghasilkan Document yang diberikan sebagai string berformat.

Parameter

Nama	Jenis	Deskripsi
`document`	`Document`	dokumen yang akan diformat

Pulang pergi

String — dokumen yang diformat

`format(element)`

Menghasilkan node Element yang diberikan sebagai string berformat.

Parameter

Nama	Jenis	Deskripsi
`element`	`Element`	elemen yang akan diformat

Pulang pergi

String — elemen berformat

`setEncoding(encoding)`

Menetapkan encoding karakter yang harus digunakan oleh pemformat. Argumen encoding harus merupakan 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 pembuatan rantai

`setIndent(indent)`

Menetapkan string yang digunakan untuk membuat indentasi node turunan relatif terhadap induknya. Menetapkan indent selain null akan menyebabkan formator menyisipkan pemisah 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 pembuatan rantai

`setLineSeparator(separator)`

Menetapkan string yang akan disisipkan setiap kali pemformat biasanya menyisipkan baris baru. Ketiga formator standar memiliki kondisi yang berbeda untuk menyisipkan baris baru. Pemisah baris default-nya 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 pembuatan rantai

`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 menghapus deklarasi XML; `false` untuk menyertakannya

Pulang pergi

Format — pemformat, untuk pembuatan rantai

`setOmitEncoding(omitEncoding)`

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

Parameter

Nama	Jenis	Deskripsi
`omitEncoding`	`Boolean`	`true` untuk menghapus encoding dalam deklarasi XML; `false` untuk menyertakannya

Pulang pergi

Format — pemformat, untuk pembuatan rantai