Class Format

Format

Ein Formatierungstool zum Ausgeben 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 der Formatierer verwenden soll.
setIndent(indent)	Format	Hiermit wird der String festgelegt, mit dem untergeordnete Knoten relativ zu ihren übergeordneten Elementen eingerückt werden.
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 auslassen soll, z. B. <?xml version="1.0" encoding="UTF-8"?>.
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 der Formatierer verwenden soll. Das encoding-Argument muss eine zulässige 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, für die Verkettung

---

setIndent(indent)

Hiermit wird der String festgelegt, mit dem untergeordnete Knoten relativ zu ihren übergeordneten Elementen eingerückt werden. 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.
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	die einzurückende Zeile

Rückflug

Format – der Formatierer, für die 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 Formatierungsoptionen haben unterschiedliche Bedingungen, unter denen ein Zeilenumbruch eingefügt wird. Das Standardzeilenendzeichen 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, für die Verkettung

---

setOmitDeclaration(omitDeclaration)

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

Parameter

Name	Typ	Beschreibung
omitDeclaration	Boolean	true, um die XML-Deklaration auszuschließen, oder false, um sie einzubeziehen

Rückflug

Format – der Formatierer, für die 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 zu ignorieren, oder false, um sie einzubeziehen.

Rückflug

Format – der Formatierer, für die Verkettung