Class Format

形式

XML ドキュメントを出力するためのフォーマッタ。さらにカスタマイズ可能な 3 つの事前定義された形式があります。

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

メソッド

メソッド戻り値の型概要
format(document)String指定された Document をフォーマットされた文字列として出力します。
format(element)String指定された Element ノードをフォーマットされた文字列として出力します。
setEncoding(encoding)Formatフォーマッタが使用する文字エンコードを設定します。
setIndent(indent)Format親ノードに対して子ノードをインデントするために使用される文字列を設定します。
setLineSeparator(separator)Formatフォーマッタが通常改行を挿入するときに挿入する文字列を設定します。
setOmitDeclaration(omitDeclaration)Formatフォーマッタが XML 宣言（<?xml version="1.0" encoding="UTF-8"?> など）を省略するかどうかを設定します。
setOmitEncoding(omitEncoding)Formatフォーマッタが XML 宣言のエンコード（<?xml version="1.0" encoding="UTF-8"?> のエンコード フィールドなど）を省略するかどうかを設定します。

詳細なドキュメント

format(document)

指定された Document をフォーマットされた文字列として出力します。

パラメータ

名前型説明
documentDocument書式設定するドキュメント

戻る

String - 書式設定されたドキュメント

format(element)

指定された Element ノードをフォーマットされた文字列として出力します。

パラメータ

名前型説明
elementElement書式設定する要素

戻る

String - 書式設定された要素

setEncoding(encoding)

フォーマッタが使用する文字エンコードを設定します。encoding 引数は、ISO-8859-1、US-ASCII、UTF-8、UTF-16 などの承認済みの XML エンコードである必要があります。

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

パラメータ

名前型説明
encodingString使用するエンコード

戻る

Format - チェーン用のフォーマッタ

setIndent(indent)

親ノードに対して子ノードをインデントするために使用される文字列を設定します。null 以外のインデントを設定すると、フォーマッタは各ノードの後に改行を挿入します。

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

パラメータ

名前型説明
indentString使用するインデント

戻る

Format - チェーン用のフォーマッタ

setLineSeparator(separator)

フォーマッタが通常改行を挿入するときに挿入する文字列を設定します。3 つの事前定義されたフォーマッタでは、改行を挿入する条件が異なります。デフォルトの行区切り文字は \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);

パラメータ

名前型説明
separatorString使用する区切り文字

戻る

Format - チェーン用のフォーマッタ

setOmitDeclaration(omitDeclaration)

フォーマッタが XML 宣言（<?xml version="1.0" encoding="UTF-8"?> など）を省略するかどうかを設定します。

パラメータ

名前型説明
omitDeclarationBooleantrue: XML 宣言を省略します。false: XML 宣言を含めます。

戻る

Format - チェーン用のフォーマッタ

setOmitEncoding(omitEncoding)

フォーマッタが XML 宣言のエンコード（<?xml version="1.0" encoding="UTF-8"?> のエンコード フィールドなど）を省略するかどうかを設定します。

パラメータ

名前型説明
omitEncodingBooleantrue: XML 宣言でエンコードを省略します。false: エンコードを含めます。

戻る

Format - チェーン用のフォーマッタ