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 có thể tuỳ chỉnh thêm.

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

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
format(document)StringXuất ra Document cho trước dưới dạng chuỗi đã định dạng.
format(element)StringXuất ra nút Element đã cho dưới dạng một chuỗi đã định dạng.
setEncoding(encoding)FormatĐặt phương thức mã hoá ký tự mà trình định dạng nên 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 dấu ngắt dòng.
setOmitDeclaration(omitDeclaration)FormatĐặt xem trình định dạng có bỏ qua phần khai báo XML hay không, chẳng hạn như <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)FormatThiết lập xem trình định dạng có nên bỏ qua việc mã hoá trong phần 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 ra Document cho trước dưới dạng chuỗi đã định dạng.

Các tham số

TênLoạiNội dung mô tả
documentDocumenttài liệu để định dạng

Cầu thủ trả bóng

String — tài liệu đã định dạng


format(element)

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

Các tham số

TênLoạiNội dung mô tả
elementElementphần tử cần định dạng

Cầu thủ trả bóng

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


setEncoding(encoding)

Đặt phương thức mã hoá ký tự mà trình định dạng nên sử dụng. Đối số encoding phải là một phương thức 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.
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);

Các tham số

TênLoạiNội dung mô tả
encodingStringmã hoá để 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 giá trị thụt lề khác với null sẽ khiến trình định dạng chèn một dấu ngắt dòng sau mỗi nút.

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

Các tham số

TênLoạiNội dung mô tả
indentStringthụt lề để sử dụng

Cầu thủ trả bóng

Format – trình định dạng để tạo chuỗi


setLineSeparator(separator)

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

Các tham số

TênLoạiNội dung mô tả
separatorStringdấu phân cách để 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ó bỏ qua phần khai báo XML hay không, chẳng hạn như <?xml version="1.0" encoding="UTF-8"?>.

Các tham số

TênLoạiNội dung mô tả
omitDeclarationBooleantrue để bỏ qua phần khai báo XML; false để bao gồm phần khai báo này

Cầu thủ trả bóng

Format – trình định dạng để tạo chuỗi


setOmitEncoding(omitEncoding)

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

Các tham số

TênLoạiNội dung mô tả
omitEncodingBooleantrue để bỏ qua chế độ mã hoá trong phần khai báo XML; false để đưa mã này vào

Cầu thủ trả bóng

Format – trình định dạng để tạo chuỗi