Class Format

Biçim

Daha da özelleştirilebilen üç önceden tanımlanmış biçim içeren bir XML dokümanı çıkışı biçimlendiricisi.

// 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ş dize olarak döndürür.
format(element)	String	Belirtilen Element düğümünü biçimlendirilmiş bir dize olarak döndürür.
setEncoding(encoding)	Format	Düzenleyicinin kullanması gereken karakter kodlamasını ayarlar.
setIndent(indent)	Format	Alt düğümleri ebeveynlerine göre girintili hale getirmek için kullanılan dizeyi ayarlar.
setLineSeparator(separator)	Format	Düzenleyici normalde satır sonu eklediğinde eklenecek dizeyi ayarlar.
setOmitDeclaration(omitDeclaration)	Format	Düzenleyicinin XML bildirimini (ör. <?xml version="1.0" encoding="UTF-8"?>) atlayıp atlamayacağı belirlenir.
setOmitEncoding(omitEncoding)	Format	Biçimlendiricinin, XML beyanında kodlamayı (ör. <?xml version="1.0" encoding="UTF-8"?> içindeki kodlama alanı) atlayıp atlamayacağı ayarlar.

Ayrıntılı dokümanlar

format(document)

Belirtilen Document değerini biçimlendirilmiş dize olarak döndürür.

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 döndürür.

Parametreler

Ad	Tür	Açıklama
element	Element	biçimlendirilecek öğe

Return

String: biçimlendirilmiş öğe

---

setEncoding(encoding)

Düzenleyicinin 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 ebeveynlerine göre girintili hale getirmek için kullanılan dizeyi ayarlar. Girintiyi null dışında bir değere 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)

Düzenleyici normalde satır sonu eklediğinde eklenecek dizeyi ayarlar. Önceden tanımlanmış üç biçimlendiricinin satır sonu eklediği koşullar farklıdır. Varsayılan satır ayırıcı \r\n'tir.

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

Düzenleyicinin XML bildirimini (ör. <?xml version="1.0" encoding="UTF-8"?>) atlayıp atlamayacağı belirlenir.

Parametreler

Ad	Tür	Açıklama
omitDeclaration	Boolean	XML beyanını çıkarmak için true, dahil etmek için false

Return

Format: zincirleme için biçimlendirici

---

setOmitEncoding(omitEncoding)

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

Parametreler

Ad	Tür	Açıklama
omitEncoding	Boolean	XML beyanında kodlamayı çıkarmak için true; kodlamayı dahil etmek için false

Return

Format: zincirleme için biçimlendirici