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ể được 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ứcLoại dữ liệu trả vềMô tả ngắn
format(document)StringXuất Document đã cho dưới dạng một chuỗi được định dạng.
format(element)StringXuất nút Element đã cho dưới dạng một chuỗi được định dạng.
setEncoding(encoding)FormatĐặt kiểu 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ó 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)FormatĐặt xem trình định dạng có 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 Document đã cho dưới dạng một chuỗi được định dạng.

Tham số

TênLoạiMô tả
documentDocumenttài liệu cần định dạng

Cầu thủ trả bóng

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


format(element)

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

Tham số

TênLoạiMô 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 kiểu mã hoá ký tự mà trình định dạng sẽ sử dụng. Đối số encoding phải là một 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ênLoạiMô tả
encodingStringbộ 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 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ênLoạiMô tả
indentStringkhoảng 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 chèn dòng khác nhau. 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ênLoạiMô tả
separatorStringdòng 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ó bỏ qua phần khai báo XML hay không, chẳng hạn như <?xml version="1.0" encoding="UTF-8"?>.

Tham số

TênLoạiMô tả
omitDeclarationBooleantrue để bỏ qua phần khai báo XML; false để đưa phần khai báo đó 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ó 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"?>.

Tham số

TênLoạiMô tả
omitEncodingBooleantrue để bỏ qua mã hoá trong phần khai báo XML; false để đưa mã hoá vào

Cầu thủ trả bóng

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