Se usó la API de Cloud Translation para traducir esta página.

Class Format

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

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`format(document)`	`String`	Muestra la `Document` determinada como una string con formato.
`format(element)`	`String`	Genera el nodo `Element` determinado como una string con formato.
`setEncoding(encoding)`	`Format`	Establece la codificación de caracteres que debe usar el formateador.
`setIndent(indent)`	`Format`	Establece la string que se usa para aplicar sangría a los nodos secundarios en relación con los elementos superiores.
`setLineSeparator(separator)`	`Format`	Fija la cadena que se inserta cuando el formateador normalmente inserta un salto de línea.
`setOmitDeclaration(omitDeclaration)`	`Format`	Establece si el formateador debe omitir la declaración XML, como `<?xml version="1.0" encoding="UTF-8"?>`.
`setOmitEncoding(omitEncoding)`	`Format`	Establece si el formateador debe omitir la codificación en la declaración en formato XML, como en el campo de codificación en `<?xml version="1.0" encoding="UTF-8"?>`.

Documentación detallada

`format(document)`

Muestra la Document determinada como una string con formato.

Parámetros

Nombre	Tipo	Descripción
`document`	`Document`	al documento para darle formato

Devolvedor

String: Es el documento con formato.

`format(element)`

Genera el nodo Element determinado como una string con formato.

Parámetros

Nombre	Tipo	Descripción
`element`	`Element`	el elemento a formatear

Devolvedor

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

Parámetros

Nombre	Tipo	Descripción
`encoding`	`String`	la codificación para usar

Devolvedor

Format: El formateador, para el encadenamiento

`setIndent(indent)`

Establece la string que se usa para aplicar sangría a los nodos secundarios en relación con los elementos superiores. Si se configura una sangría distinta 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.
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);

Parámetros

Nombre	Tipo	Descripción
`indent`	`String`	la sangría que se usará

Devolvedor

Format: El formateador, para el encadenamiento

`setLineSeparator(separator)`

Fija la cadena que se inserta cuando el formateador normalmente inserta un salto de línea. Los tres formateadores predefinidos tienen diferentes condiciones en las que insertan un salto de línea. El separador de línea predeterminado es \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);

Parámetros

Nombre	Tipo	Descripción
`separator`	`String`	el separador que se usará

Devolvedor

Format: El formateador, para el encadenamiento

`setOmitDeclaration(omitDeclaration)`

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

Parámetros

Nombre	Tipo	Descripción
`omitDeclaration`	`Boolean`	`true` para omitir la declaración XML; `false` para incluirla

Devolvedor

Format: El formateador, para el encadenamiento

`setOmitEncoding(omitEncoding)`

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

Parámetros

Nombre	Tipo	Descripción
`omitEncoding`	`Boolean`	`true` para omitir la codificación en la declaración XML; `false` para incluirla

Devolvedor

Format: El formateador, para el encadenamiento