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एक्सएमएल एलान को शामिल करने के लिए false और उसे हटाने के लिए true

वापसी का टिकट

Format — चेन करने के लिए फ़ॉर्मैटर


setOmitEncoding(omitEncoding)

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

पैरामीटर

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

वापसी का टिकट

Format — चेन करने के लिए फ़ॉर्मैटर