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

Metodi

MetodoTipo restituitoBreve descrizione
format(document)StringRestituisce il valore Document specificato come stringa formattata.
format(element)StringRestituisce il nodo Element specificato come stringa formattata.
setEncoding(encoding)FormatConsente di impostare la codifica dei caratteri che il formattatore deve utilizzare.
setIndent(indent)FormatImposta la stringa utilizzata per far rientrare i nodi figlio rispetto ai relativi nodi padre.
setLineSeparator(separator)FormatImposta la stringa da inserire ogni volta che il formattatore inserisce normalmente un'interruzione di riga.
setOmitDeclaration(omitDeclaration)FormatConsente di impostare se il formattatore deve omettere la dichiarazione XML, ad esempio <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)FormatConsente di impostare se il formattatore deve omettere la codifica nella dichiarazione XML, ad esempio campo di codifica in <?xml version="1.0" encoding="UTF-8"?>.

Documentazione dettagliata

format(document)

Restituisce il valore Document specificato come stringa formattata.

Parametri

NomeTipoDescrizione
documentDocumentil documento per formattare

Invio

String: il documento formattato


format(element)

Restituisce il nodo Element specificato come stringa formattata.

Parametri

NomeTipoDescrizione
elementElementl'elemento da formattare

Invio

String: l'elemento formattato


setEncoding(encoding)

Consente di impostare la codifica dei caratteri che il formattatore deve utilizzare. L'argomento encoding deve Essere una codifica XML accettata come ISO-8859-1, US-ASCII, UTF-8 o 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);

Parametri

NomeTipoDescrizione
encodingStringla codifica per utilizzare

Invio

Format: il formattatore per il concatenamento


setIndent(indent)

Imposta la stringa utilizzata per far rientrare i nodi figlio rispetto ai relativi nodi padre. Impostazione di un rientro per altro di null fa sì che il formattatore inserisca un'interruzione di riga dopo ogni nodo.

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

Parametri

NomeTipoDescrizione
indentStringil rientro per utilizzare

Invio

Format: il formattatore per il concatenamento


setLineSeparator(separator)

Imposta la stringa da inserire ogni volta che il formattatore inserisce normalmente un'interruzione di riga. I tre i formatter predefiniti presentano condizioni diverse in cui inseriscono un'interruzione di riga. La il separatore di riga predefinito è \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);

Parametri

NomeTipoDescrizione
separatorStringil separatore da utilizzare

Invio

Format: il formattatore per il concatenamento


setOmitDeclaration(omitDeclaration)

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

Parametri

NomeTipoDescrizione
omitDeclarationBooleantrue per omettere la dichiarazione XML; false per includerla

Invio

Format: il formattatore per il concatenamento


setOmitEncoding(omitEncoding)

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

Parametri

NomeTipoDescrizione
omitEncodingBooleantrue per omettere la codifica nella dichiarazione XML. false per includilo

Invio

Format: il formattatore per il concatenamento