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
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 | Consente di impostare la codifica dei caratteri che il formattatore deve utilizzare. |
setIndent(indent) | Format | Imposta la stringa utilizzata per far rientrare i nodi figlio rispetto ai relativi nodi padre. |
setLineSeparator(separator) | Format | Imposta la stringa da inserire ogni volta che il formattatore inserisce normalmente un'interruzione di riga. |
setOmitDeclaration(omitDeclaration) | Format | Consente di impostare se il formattatore deve omettere la dichiarazione XML, ad esempio <?xml version="1.0"
encoding="UTF-8"?> . |
setOmitEncoding(omitEncoding) | Format | 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"?> . |
Documentazione dettagliata
format(document)
format(element)
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
Nome | Tipo | Descrizione |
---|---|---|
encoding | String | la 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
Nome | Tipo | Descrizione |
---|---|---|
indent | String | il 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
Nome | Tipo | Descrizione |
---|---|---|
separator | String | il 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
Nome | Tipo | Descrizione |
---|---|---|
omitDeclaration | Boolean | true 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
Nome | Tipo | Descrizione |
---|---|---|
omitEncoding | Boolean | true per omettere la codifica nella dichiarazione XML. false per
includilo |
Invio
Format
: il formattatore per il concatenamento