דף זה תורגם על ידי Cloud Translation API.

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 כמחרוזת בפורמט.

פרמטרים

שם	סוג	תיאור
`document`	`Document`	המסמך שרוצים לעצב

חזרה

String – המסמך המפורמט

`format(element)`

הפונקציה מפיקה את הצומת Element הנתון כמחרוזת בפורמט.

פרמטרים

שם	סוג	תיאור
`element`	`Element`	הרכיב שרוצים לעצב

חזרה

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

פרמטרים

שם	סוג	תיאור
`encoding`	`String`	הקידוד שבו רוצים להשתמש

חזרה

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

פרמטרים

שם	סוג	תיאור
`indent`	`String`	הפסקה שרוצים להשתמש בה

חזרה

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

פרמטרים

שם	סוג	תיאור
`separator`	`String`	המפריד שבו רוצים להשתמש

חזרה

Format – הפורמט, לשרשור

`setOmitDeclaration(omitDeclaration)`

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

פרמטרים

שם	סוג	תיאור
`omitDeclaration`	`Boolean`	`true` כדי להשמיט את הצהרת ה-XML, `false` כדי לכלול אותה

חזרה

Format – הפורמט, לשרשור

`setOmitEncoding(omitEncoding)`

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

פרמטרים

שם	סוג	תיאור
`omitEncoding`	`Boolean`	`true` כדי להשמיט את הקידוד בהצהרת ה-XML, `false` כדי לכלול אותו

חזרה

Format – הפורמט, לשרשור