Class Format

Định dạng

Một trình định dạng để xuất tài liệu XML, với 3 định dạng được xác định trước mà bạn có thể tuỳ chỉnh thêm.

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

Phương thức

Phương thức	Kiểu dữ liệu trả về	Mô tả ngắn
format(document)	String	Xuất Document đã cho dưới dạng một chuỗi được định dạng.
format(element)	String	Xuất nút Element đã cho dưới dạng một chuỗi được định dạng.
setEncoding(encoding)	Format	Đặt chế độ mã hoá ký tự mà trình định dạng sẽ sử dụng.
setIndent(indent)	Format	Đặt chuỗi dùng để thụt lề các nút con so với nút mẹ.
setLineSeparator(separator)	Format	Đặt chuỗi cần chèn bất cứ khi nào trình định dạng thường chèn một ký tự ngắt dòng.
setOmitDeclaration(omitDeclaration)	Format	Đặt xem trình định dạng có bỏ qua khai báo XML hay không, chẳng hạn như <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)	Format	Đặt xem trình định dạng có bỏ qua việc mã hoá trong khai báo XML hay không, chẳng hạn như trường mã hoá trong <?xml version="1.0" encoding="UTF-8"?>.

Tài liệu chi tiết

format(document)

Xuất Document đã cho dưới dạng một chuỗi được định dạng.

Thông số

Tên	Loại	Mô tả
document	Document	Tài liệu cần định dạng.

Cầu thủ trả bóng

String – Tài liệu được định dạng.

---

format(element)

Xuất nút Element đã cho dưới dạng một chuỗi được định dạng.

Thông số

Tên	Loại	Mô tả
element	Element	Phần tử cần định dạng.

Cầu thủ trả bóng

String – Phần tử được định dạng.

---

setEncoding(encoding)

Đặt chế độ mã hoá ký tự mà trình định dạng sẽ sử dụng. Đối số encoding phải là một phương thức mã hoá XML được chấp nhận, chẳng hạn như ISO-8859-1, US-ASCII, UTF-8 hoặc UTF-16.

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

Thông số

Tên	Loại	Mô tả
encoding	String	Bộ mã hoá cần sử dụng.

Cầu thủ trả bóng

Format – Trình định dạng, để liên kết.

---

setIndent(indent)

Đặt chuỗi dùng để thụt lề các nút con so với nút mẹ. Việc đặt một khoảng thụt đầu dòng khác với null sẽ khiến trình định dạng chèn dấu ngắt dòng sau mỗi nút.

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

Thông số

Tên	Loại	Mô tả
indent	String	Khoảng thụt đầu dòng cần sử dụng.

Cầu thủ trả bóng

Format – Trình định dạng, để liên kết.

---

setLineSeparator(separator)

Đặt chuỗi cần chèn bất cứ khi nào trình định dạng thường chèn một ký tự ngắt dòng. Ba trình định dạng được xác định trước có các điều kiện khác nhau để chèn dấu ngắt dòng. Dấu phân cách dòng mặc định là \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);

Thông số

Tên	Loại	Mô tả
separator	String	Dấu phân cách cần sử dụng.

Cầu thủ trả bóng

Format – Trình định dạng, để liên kết.

---

setOmitDeclaration(omitDeclaration)

Đặt xem trình định dạng có bỏ qua khai báo XML hay không, chẳng hạn như <?xml version="1.0" encoding="UTF-8"?>.

Thông số

Tên	Loại	Mô tả
omitDeclaration	Boolean	true để bỏ qua khai báo XML; false để thêm khai báo XML.

Cầu thủ trả bóng

Format – Trình định dạng, để liên kết.

---

setOmitEncoding(omitEncoding)

Đặt xem trình định dạng có bỏ qua việc mã hoá trong khai báo XML hay không, chẳng hạn như trường mã hoá trong <?xml version="1.0" encoding="UTF-8"?>.

Thông số

Tên	Loại	Mô tả
omitEncoding	Boolean	true để bỏ qua việc mã hoá trong khai báo XML; false để thêm việc mã hoá.

Cầu thủ trả bóng

Format – Trình định dạng, để liên kết.