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 برای حذف اعلان XML true و برای درج آن از false استفاده می‌شود.

بازگشت

Format — قالب‌بندی، برای زنجیره‌سازی.

set Omit Encoding(omitEncoding)

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

پارامترها

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

بازگشت

Format — قالب‌بندی، برای زنجیره‌سازی.