Class Format

Biçim

Üç önceden tanımlanmış biçime sahip ve daha fazla özelleştirilebilen bir XML belgesi oluşturmak için biçimlendirici.

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

Yöntemler

Yöntem	Dönüş türü	Kısa açıklama
format(document)	String	Belirtilen Document değerini biçimlendirilmiş bir dize olarak verir.
format(element)	String	Belirtilen Element düğümünü biçimlendirilmiş bir dize olarak çıkarır.
setEncoding(encoding)	Format	Biçimlendiricinin kullanması gereken karakter kodlamasını ayarlar.
setIndent(indent)	Format	Alt düğümleri üst düğümlerine göre girintilemek için kullanılan dizeyi ayarlar.
setLineSeparator(separator)	Format	Biçimlendiricinin normalde satır sonu ekleyeceği her yere eklenecek dizeyi ayarlar.
setOmitDeclaration(omitDeclaration)	Format	Biçimlendiricinin <?xml version="1.0" encoding="UTF-8"?> gibi XML bildirimini atlayıp atlamayacağını ayarlar.
setOmitEncoding(omitEncoding)	Format	Biçimlendiricinin, XML bildirimindeki kodlamayı (ör. <?xml version="1.0" encoding="UTF-8"?> içindeki kodlama alanı) atlayıp atlamayacağını ayarlar.

Ayrıntılı belgeler

format(document)

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

Parametreler

Ad	Tür	Açıklama
document	Document	Biçimlendirilecek doküman.

Return

String: Biçimlendirilmiş doküman.

---

format(element)

Belirtilen Element düğümünü biçimlendirilmiş bir dize olarak çıkarır.

Parametreler

Ad	Tür	Açıklama
element	Element	Biç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.
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);

Parametreler

Ad	Tür	Açıklama
encoding	String	Kullanılacak kodlama.

Return

Format: Zincirleme için biçimlendirici.

---

setIndent(indent)

Alt düğümleri üst düğümlerine göre girintilemek 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.
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);

Parametreler

Ad	Tür	Açıklama
indent	String	Kullanılacak girinti.

Return

Format: Zincirleme için biçimlendirici.

---

setLineSeparator(separator)

Biçimlendiricinin normalde satır sonu ekleyeceği her yere eklenecek dizeyi ayarlar. Önceden tanımlanmış üç biçimlendiricinin satır sonu ekleme koşulları farklıdır. Varsayılan satır ayırıcı \r\n'dır.

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

Parametreler

Ad	Tür	Açıklama
separator	String	Kullanılacak ayırıcı.

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ı ayarlar.

Parametreler

Ad	Tür	Açıklama
omitDeclaration	Boolean	XML bildirimini atlamak için true, dahil etmek için false seçeneğini kullanın.

Return

Format: Zincirleme için biçimlendirici.

---

setOmitEncoding(omitEncoding)

Biçimlendiricinin, XML bildirimindeki kodlamayı (ör. <?xml version="1.0" encoding="UTF-8"?> içindeki kodlama alanı) atlayıp atlamayacağını ayarlar.

Parametreler

Ad	Tür	Açıklama
omitEncoding	Boolean	true, XML bildiriminde kodlamayı atlamak için; false ise kodlamayı dahil etmek için kullanılır.

Return

Format: Zincirleme için biçimlendirici.