Class Format

Format

Pemformat untuk menghasilkan dokumen XML, dengan tiga format yang telah ditentukan dan bisa lebih disesuaikan.

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

MetodeJenis hasil yang ditampilkanDeskripsi singkat
format(document)StringMenghasilkan Document yang diberikan sebagai string yang diformat.
format(element)StringMenghasilkan node Element yang diberikan sebagai string yang diformat.
setEncoding(encoding)FormatMenetapkan encoding karakter yang harus digunakan pemformat.
setIndent(indent)FormatMenetapkan string yang digunakan untuk mengindentasi node turunan secara relatif terhadap induknya.
setLineSeparator(separator)FormatMenetapkan string yang akan disisipkan setiap kali pemformat biasanya menyisipkan pemisah baris.
setOmitDeclaration(omitDeclaration)FormatMenetapkan apakah pemformat harus menghilangkan deklarasi XML, seperti <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)FormatMenetapkan 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 diberikan sebagai string yang diformat.

Parameter

NamaJenisDeskripsi
documentDocumentdokumen untuk diformat

Pulang pergi

String — dokumen berformat


format(element)

Menghasilkan node Element yang diberikan sebagai string yang diformat.

Parameter

NamaJenisDeskripsi
elementElementelemen 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.
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

NamaJenisDeskripsi
encodingStringencoding untuk menggunakan

Pulang pergi

Format — pemformat, untuk perantaian


setIndent(indent)

Menetapkan string yang digunakan untuk mengindentasi node turunan secara relatif terhadap induknya. Menetapkan indentasi lainnya dari null akan menyebabkan pemformat menyisipkan pemisah 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

NamaJenisDeskripsi
indentStringindentasi yang akan digunakan

Pulang pergi

Format — pemformat, untuk perantaian


setLineSeparator(separator)

Menetapkan string yang akan disisipkan setiap kali pemformat biasanya menyisipkan pemisah baris. Tiga pemformat yang telah ditetapkan memiliki kondisi berbeda di mana mereka menyisipkan pemisah baris. Tujuan 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

NamaJenisDeskripsi
separatorStringpemisah untuk menggunakan

Pulang pergi

Format — pemformat, untuk perantaian


setOmitDeclaration(omitDeclaration)

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

Parameter

NamaJenisDeskripsi
omitDeclarationBooleantrue untuk menghilangkan deklarasi XML; false untuk menyertakannya

Pulang pergi

Format — pemformat, untuk perantaian


setOmitEncoding(omitEncoding)

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

Parameter

NamaJenisDeskripsi
omitEncodingBooleantrue untuk menghilangkan encoding dalam deklarasi XML; false hingga sertakan

Pulang pergi

Format — pemformat, untuk perantaian