Questa pagina è stata tradotta dall'API Cloud Translation.

Class Format

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

// 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`	Consente di visualizzare `Document` specificato come stringa formattata.
`format(element)`	`String`	Consente di visualizzare il nodo `Element` specificato come stringa formattata.
`setEncoding(encoding)`	`Format`	Imposta la codifica dei caratteri da utilizzare dal formattatore.
`setIndent(indent)`	`Format`	Imposta la stringa utilizzata per rientrare i nodi secondari rispetto ai nodi principali.
`setLineSeparator(separator)`	`Format`	Imposta la stringa da inserire ogni volta che il formattatore inserisce normalmente un'interruzione di riga.
`setOmitDeclaration(omitDeclaration)`	`Format`	Imposta se l'analizzatore deve omettere la dichiarazione XML, ad esempio `<?xml version="1.0" encoding="UTF-8"?>`.
`setOmitEncoding(omitEncoding)`	`Format`	Imposta se l'analizzatore deve omettere la codifica nella dichiarazione XML, ad esempio il campo di codifica in `<?xml version="1.0" encoding="UTF-8"?>`.

Documentazione dettagliata

`format(document)`

Consente di visualizzare Document specificato come stringa formattata.

Parametri

Nome	Tipo	Descrizione
`document`	`Document`	il documento da formattare

Invio

String: il documento formattato

`format(element)`

Consente di visualizzare il nodo Element specificato come stringa formattata.

Parametri

Nome	Tipo	Descrizione
`element`	`Element`	l'elemento da formattare

Invio

String: l'elemento formattato

`setEncoding(encoding)`

Imposta la codifica dei caratteri da utilizzare 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

Invio

Format: il formatore, per l'accodamento

`setIndent(indent)`

Imposta la stringa utilizzata per rientrare i nodi secondari rispetto ai nodi principali. Se imposti un rientro diverso da null, il programma di formattazione inserirà un a capo 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

Invio

Format: il formatore, per l'accodamento

`setLineSeparator(separator)`

Imposta la stringa da inserire ogni volta che il formattatore inserisce normalmente un'interruzione di riga. I tre formattatori predefiniti hanno condizioni diverse in base alle quali inseriscono un a capo. 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

Invio

Format: il formatore, per l'accodamento

`setOmitDeclaration(omitDeclaration)`

Imposta se l'analizzatore 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

Invio

Format: il formatore, per l'accodamento

`setOmitEncoding(omitEncoding)`

Imposta se l'analizzatore deve omettere la codifica nella dichiarazione XML, ad esempio il campo di codifica 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

Invio

Format: il formatore, per l'accodamento