Class Format

Format

Ein Formatierungstool für die Ausgabe eines XML-Dokuments mit drei vordefinierten Formaten, die weiter angepasst werden können.

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

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
format(document)	String	Gibt die angegebene 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 Formatierungsprogramm verwendet werden soll.
setIndent(indent)	Format	Legt den String fest, der zum Einrücken von untergeordneten Knoten relativ zu ihren übergeordneten Knoten verwendet wird.
setLineSeparator(separator)	Format	Legt den String fest, der 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 weglassen soll, z. B. das Codierungsfeld in <?xml version="1.0" encoding="UTF-8"?>.

Detaillierte Dokumentation

format(document)

Gibt die angegebene Document als formatierten String aus.

Parameter

Name	Typ	Beschreibung
document	Document	Das zu formatierende Dokument.

Rückflug

String: Das formatierte Dokument.

---

format(element)

Gibt den angegebenen Element-Knoten als formatierten String aus.

Parameter

Name	Typ	Beschreibung
element	Element	Das zu formatierende Element.

Rückflug

String: Das formatierte Element.

---

setEncoding(encoding)

Legt die Zeichencodierung fest, die vom Formatierungsprogramm verwendet werden soll. Das encoding-Argument 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.
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);

Parameter

Name	Typ	Beschreibung
encoding	String	Die zu verwendende Codierung.

Rückflug

Format – Der Formatierer zur Verkettung.

---

setIndent(indent)

Legt den String fest, der zum Einrücken von untergeordneten Knoten relativ zu ihren übergeordneten Knoten verwendet wird. Wenn Sie eine Einrückung festlegen, die nicht null ist, fügt der Formatierer nach jedem Knoten einen Zeilenumbruch ein.

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

Parameter

Name	Typ	Beschreibung
indent	String	Der zu verwendende Einzug.

Rückflug

Format – Der Formatierer zur Verkettung.

---

setLineSeparator(separator)

Legt den String fest, der eingefügt werden soll, wenn der Formatierer normalerweise einen Zeilenumbruch einfügen würde. Die drei vordefinierten Formatierer fügen unter verschiedenen Bedingungen einen Zeilenumbruch ein. Das Standardtrennzeichen für Zeilen ist \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);

Parameter

Name	Typ	Beschreibung
separator	String	Das zu verwendende Trennzeichen.

Rückflug

Format – Der Formatierer zur Verkettung.

---

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 Weglassen der XML-Deklaration, false zum Einbeziehen.

Rückflug

Format – Der Formatierer zur Verkettung.

---

setOmitEncoding(omitEncoding)

Legt fest, ob der Formatierer die Codierung in der XML-Deklaration weglassen soll, z. B. das Codierungsfeld in <?xml version="1.0" encoding="UTF-8"?>.

Parameter

Name	Typ	Beschreibung
omitEncoding	Boolean	true, um die Codierung in der XML-Deklaration wegzulassen, false, um sie einzufügen.

Rückflug

Format – Der Formatierer zur Verkettung.