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

Class Format

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

// 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, למשל `<?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.
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);

פרמטרים

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

חזרה

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

פרמטרים

שם	סוג	תיאור
`indent`	`String`	כניסה שמיועדת לשימוש

חזרה

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

פרמטרים

שם	סוג	תיאור
`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 – העיצוב ליצירת שרשורים