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 को फ़ॉर्मैट की गई स्ट्रिंग के तौर पर आउटपुट करता है.

पैरामीटर

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

रिटर्न

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


format(element)

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

पैरामीटर

नामTypeब्यौरा
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);

पैरामीटर

नामTypeब्यौरा
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);

पैरामीटर

नामTypeब्यौरा
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);

पैरामीटर

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

रिटर्न

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


setOmitDeclaration(omitDeclaration)

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

पैरामीटर

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

रिटर्न

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


setOmitEncoding(omitEncoding)

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

पैरामीटर

नामTypeब्यौरा
omitEncodingBooleanएक्सएमएल एलान में कोड में बदलने के तरीके को छोड़ने के लिए true; इसे शामिल करने के लिए false

रिटर्न

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