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

MethodeRückgabetypKurzbeschreibung
format(document)StringGibt die angegebene Document als formatierten String aus.
format(element)StringGibt den angegebenen Element-Knoten als formatierten String aus.
setEncoding(encoding)FormatLegt die Zeichencodierung fest, die vom Formatierungsprogramm verwendet werden soll.
setIndent(indent)FormatLegt den String fest, der zum Einrücken von untergeordneten Knoten relativ zu ihren übergeordneten Knoten verwendet wird.
setLineSeparator(separator)FormatLegt den String fest, der eingefügt werden soll, wenn der Formatierer normalerweise einen Zeilenumbruch einfügen würde.
setOmitDeclaration(omitDeclaration)FormatLegt fest, ob der Formatierer die XML-Deklaration wie <?xml version="1.0" encoding="UTF-8"?> weglassen soll.
setOmitEncoding(omitEncoding)FormatLegt 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

NameTypBeschreibung
documentDocumentDas zu formatierende Dokument.

Rückflug

String: Das formatierte Dokument.

format(element)

Gibt den angegebenen Element-Knoten als formatierten String aus.

Parameter

NameTypBeschreibung
elementElementDas 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

NameTypBeschreibung
encodingStringDie 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 andere Einrückung 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

NameTypBeschreibung
indentStringDer 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 haben unterschiedliche Bedingungen, unter denen sie einen Zeilenumbruch einfügen. 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

NameTypBeschreibung
separatorStringDas 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

NameTypBeschreibung
omitDeclarationBooleantrue 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

NameTypBeschreibung
omitEncodingBooleantrue, um die Codierung in der XML-Deklaration wegzulassen, false, um sie einzufügen.

Rückflug

Format – Der Formatierer zur Verkettung.