Class Format

Formato

Es un formato para generar un documento XML, con tres formatos predefinidos que se pueden personalizar aún más. 

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

Métodos

MétodoTipo de datos que se muestraDescripción breve
format(document)StringMuestra el Document determinado como una cadena con formato.
format(element)StringGenera el nodo Element determinado como una cadena con formato.
setEncoding(encoding)FormatEstablece la codificación de caracteres que debe usar el formateador.
setIndent(indent)FormatEstablece la cadena que se usa para indentar los nodos secundarios en relación con sus elementos superiores.
setLineSeparator(separator)FormatEstablece la cadena que se insertará cada vez que el formato inserte un salto de línea de forma normal.
setOmitDeclaration(omitDeclaration)FormatEstablece si el formateador debe omitir la declaración XML, como <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)FormatEstablece si el formateador debe omitir la codificación en la declaración XML, como el campo de codificación en <?xml version="1.0" encoding="UTF-8"?>.

Documentación detallada

format(document)

Muestra el Document determinado como una cadena con formato.

Parámetros

NombreTipoDescripción
documentDocumentel documento al que se le aplicará el formato

Volver

String: Es el documento con formato.

format(element)

Genera el nodo Element determinado como una cadena con formato.

Parámetros

NombreTipoDescripción
elementElementel elemento al que se le aplicará el formato

Volver

String: Es el elemento con formato.

setEncoding(encoding)

Establece la codificación de caracteres que debe usar el formateador. El argumento encoding debe ser una codificación XML aceptada, como 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);

Parámetros

NombreTipoDescripción
encodingStringla codificación que se usará

Volver

Format: Es el formato para encadenar.

setIndent(indent)

Establece la cadena que se usa para indentar los nodos secundarios en relación con sus elementos superiores. Si estableces un indent distinto de null, el formateador insertará un salto de línea después de cada 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);

Parámetros

NombreTipoDescripción
indentStringel sangría que se usará

Volver

Format: Es el formato para encadenar.

setLineSeparator(separator)

Establece la cadena que se insertará cada vez que el formato inserte un salto de línea de forma normal. Los tres formatos predefinidos tienen diferentes condiciones en las que insertan un salto de línea. El separador de líneas predeterminado es \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);

Parámetros

NombreTipoDescripción
separatorStringel separador que se usará

Volver

Format: Es el formato para encadenar.

setOmitDeclaration(omitDeclaration)

Establece si el formateador debe omitir la declaración XML, como <?xml version="1.0" encoding="UTF-8"?>.

Parámetros

NombreTipoDescripción
omitDeclarationBooleantrue para omitir la declaración XML; false para incluirla

Volver

Format: Es el formato para encadenar.

setOmitEncoding(omitEncoding)

Establece si el formateador debe omitir la codificación en la declaración XML, como el campo de codificación en <?xml version="1.0" encoding="UTF-8"?>.

Parámetros

NombreTipoDescripción
omitEncodingBooleantrue para omitir la codificación en la declaración XML; false para incluirla

Volver

Format: Es el formato para encadenar.