Class Format

Format

Formateur permettant de générer un document XML, avec trois formats prédéfinis pouvant être personnalisé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éthodes

Méthode	Type renvoyé	Brève description
format(document)	String	Affiche l'Document donné sous forme de chaîne formatée.
format(element)	String	Affiche le nœud Element donné sous forme de chaîne formatée.
setEncoding(encoding)	Format	Définit l'encodage de caractères que le formateur doit utiliser.
setIndent(indent)	Format	Définit la chaîne utilisée pour indenter les nœuds enfants par rapport à leurs parents.
setLineSeparator(separator)	Format	Définit la chaîne à insérer chaque fois que le formateur insère normalement un saut de ligne.
setOmitDeclaration(omitDeclaration)	Format	Indique si le formateur doit omettre la déclaration XML, par exemple <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)	Format	Indique si le formateur doit omettre l'encodage dans la déclaration XML, comme le champ d'encodage dans <?xml version="1.0" encoding="UTF-8"?>.

Documentation détaillée

format(document)

Affiche l'Document donné sous forme de chaîne formatée.

Paramètres

Nom	Type	Description
document	Document	le document à mettre en forme ;

Renvois

String : document mis en forme

---

format(element)

Affiche le nœud Element donné sous forme de chaîne formatée.

Paramètres

Nom	Type	Description
element	Element	l'élément à mettre en forme ;

Renvois

String : élément mis en forme

---

setEncoding(encoding)

Définit l'encodage de caractères que le formateur doit utiliser. L'argument encoding doit être un codage XML accepté, comme 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);

Paramètres

Nom	Type	Description
encoding	String	l'encodage à utiliser ;

Renvois

Format : le formateur, pour le chaînage

---

setIndent(indent)

Définit la chaîne utilisée pour indenter les nœuds enfants par rapport à leurs parents. Si vous définissez une indentation autre que null, le formateur insère un saut de ligne après chaque nœud.

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

Paramètres

Nom	Type	Description
indent	String	l'indentation à utiliser

Renvois

Format : le formateur, pour le chaînage

---

setLineSeparator(separator)

Définit la chaîne à insérer chaque fois que le formateur insère normalement un saut de ligne. Les trois formateurs prédéfinis ont des conditions différentes pour insérer un saut de ligne. Le séparateur de ligne par défaut est \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);

Paramètres

Nom	Type	Description
separator	String	le séparateur à utiliser

Renvois

Format : le formateur, pour le chaînage

---

setOmitDeclaration(omitDeclaration)

Indique si le formateur doit omettre la déclaration XML, par exemple <?xml version="1.0" encoding="UTF-8"?>.

Paramètres

Nom	Type	Description
omitDeclaration	Boolean	true pour omettre la déclaration XML ; false pour l'inclure

Renvois

Format : le formateur, pour le chaînage

---

setOmitEncoding(omitEncoding)

Indique si le formateur doit omettre l'encodage dans la déclaration XML, comme le champ d'encodage dans <?xml version="1.0" encoding="UTF-8"?>.

Paramètres

Nom	Type	Description
omitEncoding	Boolean	true pour omettre l'encodage dans la déclaration XML ; false pour l'inclure

Renvois

Format : le formateur, pour le chaînage