Class Format

אופן הלימוד

מעצב לפלט של מסמך XML, עם שלושה פורמטים מוגדרים מראש שאפשר להתאים אישית. 

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

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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 כמחרוזת בפורמט מסוים.

פרמטרים

שםסוגתיאור
documentDocumentהמסמך לעיצוב.

חזרה

‫String — המסמך המעוצב.

format(element)

מחזירה את הצומת Element שצוין כמחרוזת מעוצבת.

פרמטרים

שםסוגתיאור
elementElementהרכיב לעיצוב.

חזרה

‫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.
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, כמו <?xml version="1.0" encoding="UTF-8"?>.

פרמטרים

שםסוגתיאור
omitDeclarationBoolean‫true כדי להשמיט את הצהרת ה-XML,‏ false כדי לכלול אותה.

חזרה

‫Format — הפורמט, לשרשור.

setOmitEncoding(omitEncoding)

קובע אם מעצב הפורמט צריך להשמיט את הקידוד בהצהרת ה-XML, כמו שדה הקידוד ב-<?xml version="1.0" encoding="UTF-8"?>.

פרמטרים

שםסוגתיאור
omitEncodingBoolean‫true כדי להשמיט את הקידוד בהצהרת ה-XML, ‏false כדי לכלול אותו.

חזרה

‫Format — הפורמט, לשרשור.