Halaman ini diterjemahkan oleh Cloud Translation API.

Class Format

Pemformat untuk menghasilkan output dokumen XML, dengan tiga format yang telah ditentukan sebelumnya yang dapat disesuaikan lebih lanjut.

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

Metode

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
`format(document)`	`String`	Menghasilkan `Document` yang ditentukan sebagai string berformat.
`format(element)`	`String`	Menghasilkan node `Element` yang ditentukan 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 secara relatif terhadap induknya.
`setLineSeparator(separator)`	`Format`	Menyetel string yang akan disisipkan setiap kali pemformat biasanya menyisipkan jeda baris.
`setOmitDeclaration(omitDeclaration)`	`Format`	Menetapkan apakah pemformat harus menghilangkan 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)`

Menghasilkan Document yang ditentukan sebagai string berformat.

Parameter

Nama	Jenis	Deskripsi
`document`	`Document`	dokumen untuk diformat

Return

String — dokumen berformat

`format(element)`

Menghasilkan node Element yang ditentukan sebagai string yang diformat.

Parameter

Nama	Jenis	Deskripsi
`element`	`Element`	elemen untuk diformat

Return

String — elemen berformat

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

Parameter

Nama	Jenis	Deskripsi
`encoding`	`String`	encoding untuk digunakan

Return

Format — pemformat, untuk membuat rantai

`setIndent(indent)`

Menetapkan string yang digunakan untuk mengindentasi node turunan secara 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.
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);

Parameter

Nama	Jenis	Deskripsi
`indent`	`String`	indentasi untuk digunakan

Return

Format — pemformat, untuk membuat rantai

`setLineSeparator(separator)`

Menyetel string yang akan disisipkan setiap kali pemformat biasanya menyisipkan jeda baris. Ketiga pemformat yang telah ditetapkan memiliki kondisi berbeda untuk 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.
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);

Parameter

Nama	Jenis	Deskripsi
`separator`	`String`	untuk menggunakan

Return

Format — pemformat, untuk membuat rantai

`setOmitDeclaration(omitDeclaration)`

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

Parameter

Nama	Jenis	Deskripsi
`omitDeclaration`	`Boolean`	`true` untuk menghapus deklarasi XML; `false` untuk menyertakannya

Return

Format — pemformat, untuk membuat rantai

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

Return

Format — pemformat, untuk membuat rantai