Class Format

Formato

Un formattatore per l'output di un documento XML, con tre formati predefiniti che possono essere ulteriormente personalizzati.

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

Metodi

Metodo	Tipo restituito	Breve descrizione
format(document)	String	Restituisce il valore Document specificato come stringa formattata.
format(element)	String	Restituisce il nodo Element specificato come stringa formattata.
setEncoding(encoding)	Format	Imposta la codifica dei caratteri che deve essere utilizzata dal formattatore.
setIndent(indent)	Format	Imposta la stringa utilizzata per rientrare i nodi secondari rispetto ai relativi genitori.
setLineSeparator(separator)	Format	Imposta la stringa da inserire ogni volta che il formattatore inserisce un'interruzione di riga.
setOmitDeclaration(omitDeclaration)	Format	Specifica se il formattatore deve omettere la dichiarazione XML, ad esempio <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)	Format	Specifica se il formattatore deve omettere la codifica nella dichiarazione XML, ad esempio il campo encoding in <?xml version="1.0" encoding="UTF-8"?>.

Documentazione dettagliata

format(document)

Restituisce il valore Document specificato come stringa formattata.

Parametri

Nome	Tipo	Descrizione
document	Document	Il documento da formattare.

Indietro

String: il documento formattato.

---

format(element)

Restituisce il nodo Element specificato come stringa formattata.

Parametri

Nome	Tipo	Descrizione
element	Element	L'elemento da formattare.

Indietro

String: l'elemento formattato.

---

setEncoding(encoding)

Imposta la codifica dei caratteri che deve essere utilizzata dal formattatore. L'argomento encoding deve essere una codifica XML accettata, ad esempio ISO-8859-1, US-ASCII, UTF-8 o 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);

Parametri

Nome	Tipo	Descrizione
encoding	String	La codifica da utilizzare.

Indietro

Format: il formattatore, per il concatenamento.

---

setIndent(indent)

Imposta la stringa utilizzata per rientrare i nodi secondari rispetto ai relativi genitori. Se imposti un rientro diverso da null, il formattatore inserirà un'interruzione di riga dopo ogni nodo.

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

Parametri

Nome	Tipo	Descrizione
indent	String	Il rientro da utilizzare.

Indietro

Format: il formattatore, per il concatenamento.

---

setLineSeparator(separator)

Imposta la stringa da inserire ogni volta che il formattatore inserisce un'interruzione di riga. I tre formattatori predefiniti hanno condizioni diverse in base alle quali inseriscono un'interruzione di riga. Il separatore di riga predefinito è \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);

Parametri

Nome	Tipo	Descrizione
separator	String	Il separatore da utilizzare.

Indietro

Format: il formattatore, per il concatenamento.

---

setOmitDeclaration(omitDeclaration)

Specifica se il formattatore deve omettere la dichiarazione XML, ad esempio <?xml version="1.0" encoding="UTF-8"?>.

Parametri

Nome	Tipo	Descrizione
omitDeclaration	Boolean	true per omettere la dichiarazione XML; false per includerla.

Indietro

Format: il formattatore, per il concatenamento.

---

setOmitEncoding(omitEncoding)

Specifica se il formattatore deve omettere la codifica nella dichiarazione XML, ad esempio il campo encoding in <?xml version="1.0" encoding="UTF-8"?>.

Parametri

Nome	Tipo	Descrizione
omitEncoding	Boolean	true per omettere la codifica nella dichiarazione XML; false per includerla.

Indietro

Format: il formattatore, per il concatenamento.