Class Format

Định dạng

Trình định dạng để xuất tài liệu XML, với 3 định dạng được xác định trước 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 chuỗi được định dạng.
format(element)	String	Xuất nút Element đã cho dưới dạng 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 để chèn bất cứ khi nào trình định dạng thường chèn dấu ngắt dòng.
setOmitDeclaration(omitDeclaration)	Format	Đặt xem trình định dạng có nên bỏ qua nội dung 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ó nên bỏ qua chế độ mã hoá trong nội dung 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 chuỗi được định dạng.

Tham 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 chuỗi được định dạng.

Tham 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 chế độ mã hoá XML được chấp nhậ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);

Tham số

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

Cầu thủ trả bóng

Format – Trình định dạng, để tạo chuỗi.

---

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 dấu thụt lề 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);

Tham số

Tên	Loại	Mô tả
indent	String	Dấu thụt lề cần sử dụng.

Cầu thủ trả bóng

Format – Trình định dạng, để tạo chuỗi.

---

setLineSeparator(separator)

Đặt chuỗi để chèn bất cứ khi nào trình định dạng thường chèn dấu 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);

Tham 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, để tạo chuỗi.

---

setOmitDeclaration(omitDeclaration)

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

Tham số

Tên	Loại	Mô tả
omitDeclaration	Boolean	true để bỏ qua nội dung khai báo XML; false để đưa nội dung khai báo XML vào.

Cầu thủ trả bóng

Format – Trình định dạng, để tạo chuỗi.

---

setOmitEncoding(omitEncoding)

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

Tham số

Tên	Loại	Mô tả
omitEncoding	Boolean	true để bỏ qua chế độ mã hoá trong nội dung khai báo XML; false để đưa chế độ mã hoá vào.

Cầu thủ trả bóng

Format – Trình định dạng, để tạo chuỗi.