דף זה תורגם על ידי 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 – פורמט העיצוב, לשרשור