تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

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` المحدّدة كسلسلة منسَّقة
`setEncoding(encoding)`	`Format`	تُستخدَم لضبط ترميز الأحرف الذي يجب أن يستخدمه معرِّف التنسيق.
`setIndent(indent)`	`Format`	لضبط السلسلة المستخدَمة لإدخال مسافة بادئة بين العقد الفرعية وعقدها الرئيسية
`setLineSeparator(separator)`	`Format`	تُستخدَم لضبط السلسلة التي سيتم إدراجها عندما يُدرِج المنظِّم عادةً فاصل سطر.
`setOmitDeclaration(omitDeclaration)`	`Format`	لتحديد ما إذا كان يجب على أداة التنسيق حذف إعلان XML، مثل `<?xml version="1.0" encoding="UTF-8"?>`.
`setOmitEncoding(omitEncoding)`	`Format`	لتحديد ما إذا كان يجب على أداة التنسيق حذف الترميز في إعلان XML، مثل حقل الترمّز في `<?xml version="1.0" encoding="UTF-8"?>`.

مستندات تفصيلية

`format(document)`

إخراج Document المحدَّد كسلسلة منسّقة

المعلمات

الاسم	النوع	الوصف
`document`	`Document`	المستند المطلوب تنسيقه

الإرجاع

String: المستند المنسَّق

`format(element)`

إخراج عقدة Element المحدّدة كسلسلة منسَّقة

المعلمات

الاسم	النوع	الوصف
`element`	`Element`	العنصر المطلوب تنسيقه

الإرجاع

String: العنصر المنسَّق

`setEncoding(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: أداة التنسيق لتسلسل العناصر

`setIndent(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: أداة التنسيق لتسلسل العناصر

`setLineSeparator(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: أداة التنسيق لتسلسل العناصر

`setOmitDeclaration(omitDeclaration)`

لتحديد ما إذا كان يجب على أداة التنسيق حذف إعلان XML، مثل <?xml version="1.0" encoding="UTF-8"?>.

المعلمات

الاسم	النوع	الوصف
`omitDeclaration`	`Boolean`	`true` لحذف بيان XML، `false` لتضمينه

الإرجاع

Format: أداة التنسيق لتسلسل العناصر

`setOmitEncoding(omitEncoding)`

لتحديد ما إذا كان يجب على أداة التنسيق حذف الترميز في إعلان XML، مثل حقل الترمّز في <?xml version="1.0" encoding="UTF-8"?>.

المعلمات

الاسم	النوع	الوصف
`omitEncoding`	`Boolean`	`true` لحذف ترميز البيانات في تعريف XML، `false` لتضمينه

الإرجاع

Format: أداة التنسيق لتسلسل العناصر