تمت ترجمة هذه الصفحة بواسطة 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 المحدّدة كسلسلة منسّقة.

المَعلمات

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

استرجاع الكرة

String — المستند الذي تم تنسيقه

`format(element)`

تؤدي إلى إخراج عقدة Element المحدّدة كسلسلة منسّقة.

المَعلمات

الاسم	Type	الوصف
`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);

المَعلمات

الاسم	Type	الوصف
`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);

المَعلمات

الاسم	Type	الوصف
`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);

المَعلمات

الاسم	Type	الوصف
`separator`	`String`	الفاصل المراد استخدامه

استرجاع الكرة

Format — المُنسق، للسلاسل

`setOmitDeclaration(omitDeclaration)`

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

المَعلمات

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

استرجاع الكرة

Format — المُنسق، للسلاسل

`setOmitEncoding(omitEncoding)`

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

المَعلمات

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

استرجاع الكرة

Format — المُنسق، للسلاسل