Class Format

Biçim

Daha fazla özelleştirilebilen önceden tanımlanmış üç biçime sahip XML belgesi çıkışı için bir biçimlendirici.

// 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 değerini 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üğümlerin üst düğümlerine göre girinti eklemek için kullanılan dizeyi ayarlar.
setLineSeparator(separator)FormatBiçimlendirici normalde satır sonu eklediğinde eklenecek dizeyi ayarlar.
setOmitDeclaration(omitDeclaration)FormatBiçimlendiricinin XML bildirimini çıkarıp çıkarmayacağını belirler (ör. <?xml version="1.0" encoding="UTF-8"?>).
setOmitEncoding(omitEncoding)FormatBiçimlendiricinin, XML bildirimindeki kodlamayı (<?xml version="1.0" encoding="UTF-8"?> içindeki kodlama alanı gibi) çıkarıp çıkarmayacağını belirler.

Ayrıntılı belgeler

format(document)

Belirtilen Document değerini biçimlendirilmiş bir dize olarak verir.

Parametreler

AdTürAçıklama
documentDocumentbiçimlendirilecek doküman

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
encodingStringgereken kodlamayı

Return

Format — zincirleme bağlantı için biçimlendirici


setIndent(indent)

Alt düğümlerin üst düğümlerine göre girinti eklemek için kullanılan dizeyi ayarlar. null dışında bir girinti ayarlamak, biçimlendiricinin her düğümden sonra 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 bağlantı için biçimlendirici


setLineSeparator(separator)

Biçimlendirici normalde satır sonu eklediğinde eklenecek dizeyi ayarlar. Önceden tanımlanmış üç biçimlendirici, altında satır sonu ekledikleri farklı koşullara sahiptir. Varsayılan satır ayırıcı olarak \r\n kullanılır.

// 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
separatorStringkullanılacak ayırıcı

Return

Format — zincirleme bağlantı için biçimlendirici


setOmitDeclaration(omitDeclaration)

Biçimlendiricinin XML bildirimini çıkarıp çıkarmayacağını belirler (ör. <?xml version="1.0" encoding="UTF-8"?>).

Parametreler

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

Return

Format — zincirleme bağlantı için biçimlendirici


setOmitEncoding(omitEncoding)

Biçimlendiricinin, XML bildirimindeki kodlamayı (<?xml version="1.0" encoding="UTF-8"?> içindeki kodlama alanı gibi) çıkarıp çıkarmayacağını belirler.

Parametreler

AdTürAçıklama
omitEncodingBooleanXML bildirimindeki kodlamayı atlamak için true; dahil etmek için false

Return

Format — zincirleme bağlantı için biçimlendirici