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

Class Format

Un formateador para la salida de un documento XML, con tres formatos predefinidos que pueden ser aún más personalizada.

// 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 el `Document` proporcionado como una string con formato.
`format(element)`	`String`	Muestra 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 cadena que se usa para aplicar sangría a los nodos secundarios en relación con sus nodos superiores.
`setLineSeparator(separator)`	`Format`	Establece la cadena que se insertará siempre que el formateador insertaría 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 XML, como de codificación en `<?xml version="1.0" encoding="UTF-8"?>`.

Documentación detallada

`format(document)`

Muestra el Document proporcionado como una string con formato.

Parámetros

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

Volver

String: Es el documento con formato.

`format(element)`

Muestra el nodo Element determinado como una string con formato.

Parámetros

Nombre	Tipo	Descripción
`element`	`Element`	el elemento a dar 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 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

Volver

Format: formateador, para encadenar

`setIndent(indent)`

Establece la cadena que se usa para aplicar sangría a los nodos secundarios en relación con sus nodos superiores. Cómo establecer otra sangría que null hará que el formateador inserte 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 para usar

Volver

Format: formateador, para encadenar

`setLineSeparator(separator)`

Establece la cadena que se insertará siempre que el formateador insertaría un salto de línea. Los tres Los formateadores predefinidos tienen diferentes condiciones bajo las cuales insertan un salto de línea. El 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 para usar

Volver

Format: formateador, para encadenar

`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

Volver

Format: formateador, para encadenar

`setOmitEncoding(omitEncoding)`

Establece si el formateador debe omitir la codificación en la declaración XML, como 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` a Incluir

Volver

Format: formateador, para encadenar