Class Format

फ़ॉर्मैट

यह एक फ़ॉर्मेटर है. इसका इस्तेमाल एक्सएमएल दस्तावेज़ को आउटपुट करने के लिए किया जाता है. इसमें तीन फ़ॉर्मैट पहले से तय होते हैं. इन्हें अपनी ज़रूरत के हिसाब से बदला जा सकता है.

// 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 version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)Formatइससे यह सेट किया जाता है कि फ़ॉर्मेटर को एक्सएमएल की जानकारी में एन्कोडिंग को शामिल नहीं करना चाहिए. जैसे, <?xml version="1.0" encoding="UTF-8"?> में एन्कोडिंग फ़ील्ड.

ज़्यादा जानकारी वाला दस्तावेज़

format(document)

दिए गए Document को फ़ॉर्मैट की गई स्ट्रिंग के तौर पर दिखाता है.

पैरामीटर

नामटाइपब्यौरा
documentDocumentफ़ॉर्मैट किया जाने वाला दस्तावेज़.

वापसी का टिकट

String — फ़ॉर्मैट किया गया दस्तावेज़.


format(element)

दिए गए Element नोड को फ़ॉर्मैट की गई स्ट्रिंग के तौर पर दिखाता है.

पैरामीटर

नामटाइपब्यौरा
elementElementफ़ॉर्मैट करने के लिए एलिमेंट.

वापसी का टिकट

String — फ़ॉर्मैट किया गया एलिमेंट.


setEncoding(encoding)

यह कुकी, फ़ॉर्मेटर के लिए कैरेक्टर एन्कोडिंग सेट करती है. encoding आर्ग्युमेंट, 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);

पैरामीटर

नामटाइपब्यौरा
encodingStringइस्तेमाल की जाने वाली एन्कोडिंग.

वापसी का टिकट

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

पैरामीटर

नामटाइपब्यौरा
indentStringइस्तेमाल किया जाने वाला इंडेंट.

वापसी का टिकट

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

पैरामीटर

नामटाइपब्यौरा
separatorStringइस्तेमाल किया जाने वाला सेपरेटर.

वापसी का टिकट

Format — फ़ॉर्मेटर, चेनिंग के लिए.


setOmitDeclaration(omitDeclaration)

यह विकल्प सेट करता है कि फ़ॉर्मेटर को एक्सएमएल एलान को हटाना चाहिए या नहीं. जैसे, <?xml version="1.0" encoding="UTF-8"?>.

पैरामीटर

नामटाइपब्यौरा
omitDeclarationBooleanएक्सएमएल एलान को शामिल न करने के लिए true और शामिल करने के लिए false चुनें.

वापसी का टिकट

Format — फ़ॉर्मेटर, चेनिंग के लिए.


setOmitEncoding(omitEncoding)

इससे यह सेट किया जाता है कि फ़ॉर्मेटर को एक्सएमएल की जानकारी में एन्कोडिंग को शामिल नहीं करना चाहिए. जैसे, <?xml version="1.0" encoding="UTF-8"?> में एन्कोडिंग फ़ील्ड.

पैरामीटर

नामटाइपब्यौरा
omitEncodingBooleantrue एक्सएमएल डिक्लेरेशन में एन्कोडिंग को शामिल न करने के लिए; false इसे शामिल करने के लिए.

वापसी का टिकट

Format — फ़ॉर्मेटर, चेनिंग के लिए.