Class Format

Format

Einen Formatierer zum Ausgeben eines XML-Dokuments in drei vordefinierten Formaten, die noch weiter angepasst werden können. angepasst werden.

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

MethodeRückgabetypKurzbeschreibung
format(document)StringGibt den angegebenen Document als formatierten String aus.
format(element)StringGibt den angegebenen Element-Knoten als formatierten String aus.
setEncoding(encoding)FormatLegt die Zeichencodierung fest, die vom Formatierer 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 immer dann eingefügt werden soll, wenn der Formatierer normalerweise einen Zeilenumbruch einfügen würde.
setOmitDeclaration(omitDeclaration)FormatLegt fest, ob der Formatierer die XML-Deklaration auslassen soll, z. B. <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)FormatLegt fest, ob der Formatierer die Codierung in der XML-Deklaration auslassen soll, z. B. Codierungsfeld in <?xml version="1.0" encoding="UTF-8"?>

Detaillierte Dokumentation

format(document)

Gibt den angegebenen Document als formatierten String aus.

Parameter

NameTypBeschreibung
documentDocumentum das Dokument zu formatieren,

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

NameTypBeschreibung
encodingStringdie zu verwendende Codierung

Rückflug

Format – der Formatierer für Verkettungen


setIndent(indent)

Legt den String fest, der zum Einrücken von untergeordneten Knoten relativ zu ihren übergeordneten Knoten verwendet wird. Einzug festlegen als null bewirkt, dass der Formatierer nach jedem Knoten einen Zeilenumbruch einfügt.

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

NameTypBeschreibung
indentStringden Einzug

Rückflug

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 vordefinierte Formatierer haben unterschiedliche Bedingungen, unter denen sie einen Zeilenumbruch einfügen. Die Das standardmäßige Zeilentrennzeichen 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

NameTypBeschreibung
separatorStringdas zu verwendende Trennzeichen

Rückflug

Format – der Formatierer für Verkettungen


setOmitDeclaration(omitDeclaration)

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

Parameter

NameTypBeschreibung
omitDeclarationBooleanMit true wird die XML-Deklaration weggelassen. false, um es einzuschließen

Rückflug

Format – der Formatierer für Verkettungen


setOmitEncoding(omitEncoding)

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

Parameter

NameTypBeschreibung
omitEncodingBooleanMit true wird die Codierung in der XML-Deklaration weggelassen. false bis einschließen

Rückflug

Format – der Formatierer für Verkettungen