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: أداة التنسيق، لتسلسل العمليات.