Formateur permettant de générer des documents XML, avec trois formats prédéfinis qui peuvent être personnalisé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éthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
format(document) | String | Génère l'élément Document donné en tant que chaîne mise en forme. |
format(element) | String | Génère le nœud Element donné en tant que chaîne mise en forme. |
setEncoding(encoding) | Format | Définit l'encodage des caractères que l'outil de mise en forme doit utiliser. |
setIndent(indent) | Format | Définit la chaîne utilisée pour mettre en retrait les nœuds enfants par rapport à leurs parents. |
setLineSeparator(separator) | Format | Définit la chaîne à insérer chaque fois que l'outil de mise en forme insère normalement un saut de ligne. |
setOmitDeclaration(omitDeclaration) | Format | Détermine si l'outil de mise en forme doit omettre la déclaration XML, telle que <?xml version="1.0"
encoding="UTF-8"?> . |
setOmitEncoding(omitEncoding) | Format | Détermine si l'outil de mise en forme 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)
format(element)
setEncoding(encoding)
Définit l'encodage des caractères que l'outil de mise en forme doit utiliser. L'argument encoding
doit être un encodage XML accepté, tel que ISO-8859-1
, US-ASCII
, UTF-8
ou 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);
Paramètres
Nom | Type | Description |
---|---|---|
encoding | String | l'encodage à utiliser |
Renvois
Format
: outil de mise en forme, pour le chaînage
setIndent(indent)
Définit la chaîne utilisée pour mettre en retrait les nœuds enfants par rapport à leurs parents. Si vous définissez un retrait autre que null
, l'outil de mise en forme insère un saut de ligne après chaque nœud.
// 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);
Paramètres
Nom | Type | Description |
---|---|---|
indent | String | le retrait pour utiliser |
Renvois
Format
: outil de mise en forme, pour le chaînage
setLineSeparator(separator)
Définit la chaîne à insérer chaque fois que l'outil de mise en forme insère normalement un saut de ligne. Les trois outils de mise en forme prédéfinis ont des conditions différentes dans lesquelles ils insèrent 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. 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);
Paramètres
Nom | Type | Description |
---|---|---|
separator | String | le séparateur à utiliser |
Renvois
Format
: outil de mise en forme, pour le chaînage
setOmitDeclaration(omitDeclaration)
Détermine si l'outil de mise en forme doit omettre la déclaration XML, telle que <?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
: outil de mise en forme, pour le chaînage
setOmitEncoding(omitEncoding)
Détermine si l'outil de mise en forme 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
: outil de mise en forme, pour le chaînage