Ein Formatierer zur Ausgabe eines XML-Dokuments mit drei vordefinierten Formaten, die weiter angepasst werden können.
// 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);
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
format(document) | String | Gibt den angegebenen Document als formatierten String aus. |
format(element) | String | Gibt den angegebenen Element -Knoten als formatierten String aus. |
setEncoding(encoding) | Format | Legt die Zeichencodierung fest, die vom Formatierer verwendet werden soll. |
setIndent(indent) | Format | Legt den String fest, der zum Einrücken von untergeordneten Knoten im Verhältnis zu ihren übergeordneten Knoten verwendet wird. |
setLineSeparator(separator) | Format | Legt den String fest, der immer dann eingefügt werden soll, wenn der Formatierer normalerweise einen Zeilenumbruch einfügen würde. |
setOmitDeclaration(omitDeclaration) | Format | Legt fest, ob der Formatierer die XML-Deklaration wie <?xml version="1.0"
encoding="UTF-8"?> weglassen soll. |
setOmitEncoding(omitEncoding) | Format | Legt fest, ob der Formatierer die Codierung in der XML-Deklaration wie das Codierungsfeld in <?xml version="1.0" encoding="UTF-8"?> weglassen soll. |
Detaillierte Dokumentation
format(document)
format(element)
setEncoding(encoding)
Legt die Zeichencodierung fest, die vom Formatierer verwendet werden soll. Das Argument encoding
muss eine akzeptierte XML-Codierung wie ISO-8859-1
, US-ASCII
, UTF-8
oder UTF-16
sein.
// 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);
Parameter
Name | Typ | Beschreibung |
---|---|---|
encoding | String | die zu verwendende Codierung |
Return
Format
– der Formatierer für Verkettungen
setIndent(indent)
Legt den String fest, der zum Einrücken von untergeordneten Knoten im Verhältnis zu ihren übergeordneten Knoten verwendet wird. Wenn Sie einen anderen Einzug als null
festlegen, fügt der Formatierer nach jedem Knoten einen Zeilenumbruch ein.
// 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);
Parameter
Name | Typ | Beschreibung |
---|---|---|
indent | String | den zu verwendenden Einzug |
Return
Format
– der Formatierer für Verkettungen
setLineSeparator(separator)
Legt den String fest, der immer dann eingefügt werden soll, wenn der Formatierer normalerweise einen Zeilenumbruch einfügen würde. Die drei vordefinierten Formatierer haben unterschiedliche Bedingungen, unter denen sie einen Zeilenumbruch einfügen. Das Standardtrennzeichen ist \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);
Parameter
Name | Typ | Beschreibung |
---|---|---|
separator | String | das zu verwendende Trennzeichen |
Return
Format
– der Formatierer für Verkettungen
setOmitDeclaration(omitDeclaration)
Legt fest, ob der Formatierer die XML-Deklaration wie <?xml version="1.0"
encoding="UTF-8"?>
weglassen soll.
Parameter
Name | Typ | Beschreibung |
---|---|---|
omitDeclaration | Boolean | true zum Auslassen der XML-Deklaration; false zum Einbinden |
Return
Format
– der Formatierer für Verkettungen
setOmitEncoding(omitEncoding)
Legt fest, ob der Formatierer die Codierung in der XML-Deklaration wie das Codierungsfeld in <?xml version="1.0" encoding="UTF-8"?>
weglassen soll.
Parameter
Name | Typ | Beschreibung |
---|---|---|
omitEncoding | Boolean | true , um die Codierung in der XML-Deklaration wegzulassen; false , um sie aufzunehmen |
Return
Format
– der Formatierer für Verkettungen