Class Format

قالب

یک قالب‌کننده برای خروجی یک سند XML، با سه قالب از پیش تعریف‌شده که می‌توانند بیشتر سفارشی شوند.

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

روش ها

روش نوع برگشت شرح مختصر
format(document) String Document داده شده را به عنوان یک رشته فرمت شده خروجی می دهد.
format(element) String گره Element داده شده را به عنوان یک رشته فرمت شده خروجی می دهد.
set Encoding(encoding) Format رمزگذاری کاراکتری را که قالب‌کننده باید استفاده کند را تنظیم می‌کند.
set Indent(indent) Format رشته مورد استفاده برای تورفتگی گره های فرزند نسبت به والدینشان را تنظیم می کند.
set Line Separator(separator) Format رشته را طوری تنظیم می‌کند که هر زمان که فرمت‌کننده معمولاً یک خط شکسته را وارد می‌کند، درج شود.
set Omit Declaration(omitDeclaration) Format تنظیم می‌کند که آیا قالب‌کننده باید اعلان XML را حذف کند، مانند <?xml version="1.0" encoding="UTF-8"?> .
set Omit Encoding(omitEncoding) Format تنظیم می‌کند که آیا قالب‌کننده باید کدگذاری را در اعلان XML حذف کند، مانند قسمت رمزگذاری در <?xml version="1.0" encoding="UTF-8"?> .

مستندات دقیق

format(document)

Document داده شده را به عنوان یک رشته فرمت شده خروجی می دهد.

پارامترها

نام تایپ کنید توضیحات
document Document سند برای قالب بندی

بازگشت

String - سند فرمت شده

format(element)

گره Element داده شده را به عنوان یک رشته فرمت شده خروجی می دهد.

پارامترها

نام تایپ کنید توضیحات
element Element عنصر برای قالب بندی

بازگشت

String - عنصر قالب بندی شده

set Encoding(encoding)

رمزگذاری کاراکتری را که قالب‌کننده باید استفاده کند را تنظیم می‌کند. آرگومان encoding باید یک رمزگذاری XML پذیرفته شده مانند ISO-8859-1 ، US-ASCII ، UTF-8 ، یا 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);

پارامترها

نام تایپ کنید توضیحات
encoding String رمزگذاری برای استفاده

بازگشت

Format - شکل دهنده، برای زنجیر کردن

set Indent(indent)

رشته مورد استفاده برای تورفتگی گره های فرزند نسبت به والدینشان را تنظیم می کند. تنظیم تورفتگی به غیر از null باعث می شود که فرمت کننده پس از هر گره یک خط شکسته وارد کند.

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

پارامترها

نام تایپ کنید توضیحات
indent String تورفتگی برای استفاده

بازگشت

Format - شکل دهنده، برای زنجیر کردن

set Line Separator(separator)

رشته را طوری تنظیم می‌کند که هر زمان که فرمت‌کننده معمولاً یک خط شکسته را وارد می‌کند، درج شود. سه قالب‌کننده از پیش تعریف‌شده دارای شرایط متفاوتی هستند که تحت آن یک شکست خط وارد می‌کنند. جداکننده خط پیش‌فرض \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);

پارامترها

نام تایپ کنید توضیحات
separator String جداکننده برای استفاده

بازگشت

Format - شکل دهنده، برای زنجیر کردن

set Omit Declaration(omitDeclaration)

تنظیم می‌کند که آیا قالب‌کننده باید اعلان XML را حذف کند، مانند <?xml version="1.0" encoding="UTF-8"?> .

پارامترها

نام تایپ کنید توضیحات
omit Declaration Boolean true برای حذف اعلان XML. false برای گنجاندن آن

بازگشت

Format - شکل دهنده، برای زنجیر کردن

set Omit Encoding(omitEncoding)

تنظیم می‌کند که آیا قالب‌کننده باید کدگذاری را در اعلان XML حذف کند، مانند قسمت رمزگذاری در <?xml version="1.0" encoding="UTF-8"?> .

پارامترها

نام تایپ کنید توضیحات
omit Encoding Boolean true تا رمزگذاری در اعلان XML حذف شود. false برای گنجاندن آن

بازگشت

Format - شکل دهنده، برای زنجیر کردن