Class Format

फ़ॉर्मैट

पहले से तय किए गए तीन फ़ॉर्मैट के साथ, एक एक्सएमएल दस्तावेज़ तैयार करने के लिए फ़ॉर्मैटर जिसे और कस्टमाइज़ किया गया.

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

पैरामीटर

नामटाइपब्यौरा
encodingStringकोड में बदलने का तरीका

वापसी का टिकट

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

पैरामीटर

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

वापसी का टिकट

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

पैरामीटर

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

वापसी का टिकट

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


setOmitDeclaration(omitDeclaration)

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

पैरामीटर

नामटाइपब्यौरा
omitDeclarationBooleanएक्सएमएल एलान को छोड़ने के लिए true; इसे शामिल करने के लिए false

वापसी का टिकट

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


setOmitEncoding(omitEncoding)

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

पैरामीटर

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

वापसी का टिकट

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