Class Format

Formato

Um formatador para gerar um documento XML com três formatos predefinidos que podem ser personalizados. 

// 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 retornoBreve descrição
format(document)StringMostra o Document fornecido como uma string formatada.
format(element)StringEnvia o nó Element fornecido como uma string formatada.
setEncoding(encoding)FormatDefine a codificação de caracteres que o formatador deve usar.
setIndent(indent)FormatDefine a string usada para recuar os nós filhos em relação aos pais.
setLineSeparator(separator)FormatDefine a string a ser inserida sempre que o formatador normalmente insere uma quebra de linha.
setOmitDeclaration(omitDeclaration)FormatDefine se o formatador precisa omitir a declaração XML, como <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)FormatDefine se o formatador precisa omitir a codificação na declaração XML, como o campo de codificação em <?xml version="1.0" encoding="UTF-8"?>.

Documentação detalhada

format(document)

Mostra o Document fornecido como uma string formatada.

Parâmetros

NomeTipoDescrição
documentDocumento documento a ser formatado

Retornar

String: o documento formatado

format(element)

Envia o nó Element fornecido como uma string formatada.

Parâmetros

NomeTipoDescrição
elementElemento elemento a ser formatado

Retornar

String: o elemento formatado.

setEncoding(encoding)

Define a codificação de caracteres que o formatador deve usar. O argumento encoding precisa ser uma codificação XML aceita, como ISO-8859-1, US-ASCII, UTF-8 ou 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

NomeTipoDescrição
encodingStringa codificação a ser usada

Retornar

Format: o formatador para encadeamento

setIndent(indent)

Define a string usada para recuar os nós filhos em relação aos pais. Definir um recuo diferente de null fará com que o formatador insira um retorno de carro após cada nó. 

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

NomeTipoDescrição
indentStringa indentação a ser usada

Retornar

Format: o formatador para encadeamento

setLineSeparator(separator)

Define a string a ser inserida sempre que o formatador normalmente insere uma quebra de linha. Os três formatadores predefinidos têm condições diferentes para inserir um retorno de linha. O separador de linha padrão é \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

NomeTipoDescrição
separatorStringo separador a ser usado

Retornar

Format: o formatador para encadeamento

setOmitDeclaration(omitDeclaration)

Define se o formatador precisa omitir a declaração XML, como <?xml version="1.0" encoding="UTF-8"?>.

Parâmetros

NomeTipoDescrição
omitDeclarationBooleantrue para omitir a declaração XML; false para incluí-la

Retornar

Format: o formatador para encadeamento

setOmitEncoding(omitEncoding)

Define se o formatador precisa omitir a codificação na declaração XML, como o campo de codificação em <?xml version="1.0" encoding="UTF-8"?>.

Parâmetros

NomeTipoDescrição
omitEncodingBooleantrue para omitir a codificação na declaração XML e false para incluí-la.

Retornar

Format: o formatador para encadeamento