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

Class Format

هي أداة تنسيق لإخراج مستند XML بثلاثة تنسيقات محددة مسبقًا يمكن المخصصة.

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

الطُرق

الطريقة	نوع الإرجاع	وصف قصير
`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.
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);

المعلمات

الاسم	النوع	الوصف
`encoding`	`String`	الترميز المراد استخدامه

الإرجاع

Format — أداة التنسيق، للسلاسل

`setIndent(indent)`

لضبط السلسلة المستخدمة لإضافة مسافة بادئة للعُقد الفرعية بالنسبة إلى عناصرها الرئيسية. تعيين مسافة بادئة أخرى من null إلى إدراج فاصل أسطر بعد كل عقدة في أداة التنسيق.

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

المعلمات

الاسم	النوع	الوصف
`indent`	`String`	المسافة البادئة لاستخدام

الإرجاع

Format — أداة التنسيق، للسلاسل

`setLineSeparator(separator)`

لضبط السلسلة لإدراجها عندما تُدرج أداة التنسيق عادةً فاصل أسطر. الثلاثة لجهات التنسيق المحددة مسبقًا شروط مختلفة يتم بموجبها إدراج فاصل أسطر. تشير رسالة الأشكال البيانية فاصل الأسطر التلقائي هو \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);

المعلمات

الاسم	النوع	الوصف
`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 — أداة التنسيق، للسلاسل