Class Format

Biçim

Daha sonra izlenebilecek önceden tanımlanmış üç biçime sahip, XML belgesi çıktısı almak için bir biçimlendirici özelleştirilmiş.

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

Yöntemler

YöntemDönüş türüKısa açıklama
format(document)StringBelirtilen Document öğesini biçimlendirilmiş bir dize olarak verir.
format(element)StringBelirtilen Element düğümünü biçimlendirilmiş bir dize olarak verir.
setEncoding(encoding)FormatBiçimlendiricinin kullanması gereken karakter kodlamasını ayarlar.
setIndent(indent)FormatAlt düğümlere üst düğümlerine göre girinti eklemek için kullanılan dizeyi ayarlar.
setLineSeparator(separator)FormatBiçimlendirmecinin normalde satır sonu eklediği her seferde eklenecek dizeyi ayarlar.
setOmitDeclaration(omitDeclaration)FormatBiçimlendiricinin, <?xml version="1.0" encoding="UTF-8"?> gibi XML bildirimini atlayıp atlamayacağını belirler.
setOmitEncoding(omitEncoding)FormatBiçimlendiricinin, XML bildirimindeki gibi kodlamayı atlamasını kodlama alanına sahip olmak için <?xml version="1.0" encoding="UTF-8"?> biçimini kullanın.

Ayrıntılı belgeler

format(document)

Belirtilen Document öğesini biçimlendirilmiş bir dize olarak verir.

Parametreler

AdTürAçıklama
documentDocumentbiçimlendirmek için

Return

String — biçimlendirilmiş doküman


format(element)

Belirtilen Element düğümünü biçimlendirilmiş bir dize olarak verir.

Parametreler

AdTürAçıklama
elementElementbiçimlendirilecek öğe

Return

String: Biçimlendirilmiş öğe


setEncoding(encoding)

Biçimlendiricinin kullanması gereken karakter kodlamasını ayarlar. encoding bağımsız değişkeni ISO-8859-1, US-ASCII, UTF-8 veya UTF-16 gibi kabul edilen bir XML kodlaması olmalıdır.

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

Parametreler

AdTürAçıklama
encodingStringkullanılacak kodlamayı

Return

Format — zincirleme için biçimlendirici


setIndent(indent)

Alt düğümlere üst düğümlerine göre girinti eklemek için kullanılan dizeyi ayarlar. Diğer girinti ayarlama değeri (null), biçimlendiricinin her düğümden sonra bir satır sonu eklemesine neden olur.

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

Parametreler

AdTürAçıklama
indentStringkullanılacak girinti

Return

Format — zincirleme için biçimlendirici


setLineSeparator(separator)

Biçimlendirmecinin normalde satır sonu eklediği zaman eklenecek dizeyi ayarlar. Üç önceden tanımlanmış biçimlendiricilerin satır sonu eklediği farklı koşulları vardır. İlgili içeriği oluşturmak için kullanılan varsayılan satır ayırıcı \r\n şeklindedir.

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

Parametreler

AdTürAçıklama
separatorStringayırıcı olarak

Return

Format — zincirleme için biçimlendirici


setOmitDeclaration(omitDeclaration)

Biçimlendiricinin, <?xml version="1.0" encoding="UTF-8"?> gibi XML bildirimini atlayıp atlamayacağını belirler.

Parametreler

AdTürAçıklama
omitDeclarationBooleanXML bildirimini atlamak için true; Bunu dahil etmek için false

Return

Format — zincirleme için biçimlendirici


setOmitEncoding(omitEncoding)

Biçimlendiricinin, XML bildirimindeki gibi kodlamayı atlamasını kodlama alanına sahip olmak için <?xml version="1.0" encoding="UTF-8"?> biçimini kullanın.

Parametreler

AdTürAçıklama
omitEncodingBooleanXML bildirimindeki kodlamayı atlamak için true; false - ekle

Return

Format — zincirleme için biçimlendirici