Class Element

ייצוג של צומת Element XML.

// Adds up the values listed in a sample XML document and adds a new element
// with the total.
let xml = '<things>' +
    '<plates>12</plates>' +
    '<bowls>18</bowls>' +
    '<cups>25</cups>' +
    '</things>';
const document = XmlService.parse(xml);
const root = document.getRootElement();
const items = root.getChildren();
let total = 0;
for (let i = 0; i < items.length; i++) {
  total += Number(items[i].getText());
}
const totalElement = XmlService.createElement('total').setText(total);
root.addContent(totalElement);
xml = XmlService.getPrettyFormat().format(document);
Logger.log(xml);

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
`addContent(content)`	`Element`	מוסיף את הצומת הנתון כצאצא האחרון של הצומת `Element`.
`addContent(index, content)`	`Element`	הפונקציה מוסיפה את הצומת הנתון באינדקס הנתון בין כל הצמתים שהם צאצאים ישירים של הצומת `Element`.
`cloneContent()`	`Content[]`	יוצר עותקים לא מצורפים של כל הצמתים שהם צאצאים ישירים של צומת {@code Element}.
`detach()`	`Content\|null`	מנתק את הצומת מצומת ההורה `Element`.
`getAllContent()`	`Content[]`	מחזירה את כל הצמתים שהם צאצאים ישירים של צומת {@code Element}.
`getAttribute(name)`	`Attribute\|null`	מחזירה את המאפיין של צומת `Element` הזה עם השם הנתון וללא מרחב שמות.
`getAttribute(name, namespace)`	`Attribute\|null`	מחזירה את המאפיין של צומת `Element` הזה עם השם ומרחב השמות שצוינו.
`getAttributes()`	`Attribute[]`	מחזירה את כל המאפיינים של הצומת `Element` הזה, בסדר שבו הם מופיעים במסמך.
`getChild(name)`	`Element\|null`	מחזירה את הצומת הראשון `Element` עם השם הנתון וללא מרחב שמות, שהוא צאצא ישיר של הצומת `Element`.
`getChild(name, namespace)`	`Element\|null`	מחזירה את הצומת הראשון `Element` עם השם ומרחב השמות הנתונים, שהוא צאצא ישיר של הצומת `Element` הזה.
`getChildText(name)`	`String\|null`	הפונקציה מחזירה את ערך הטקסט של הצומת עם השם הנתון וללא מרחב שמות, אם הצומת הוא צאצא ישיר של הצומת `Element`.
`getChildText(name, namespace)`	`String\|null`	מחזירה את ערך הטקסט של הצומת עם השם ומרחב השמות שצוינו, אם הצומת הוא צאצא ישיר של הצומת `Element`.
`getChildren()`	`Element[]`	מחזירה את כל הצמתים מסוג `Element` שהם צמתים משניים ישירים של הצומת `Element` הזה, לפי הסדר שבו הם מופיעים במסמך.
`getChildren(name)`	`Element[]`	מחזירה את כל הצמתים `Element` עם השם הנתון וללא מרחב שמות, שהם צאצאים ישירים של הצומת `Element` הזה, לפי הסדר שבו הם מופיעים במסמך.
`getChildren(name, namespace)`	`Element[]`	מחזירה את כל הצמתים `Element` עם השם ומרחב השמות שצוינו, שהם צאצאים ישירים של הצומת `Element`, לפי הסדר שבו הם מופיעים במסמך.
`getContent(index)`	`Content\|null`	מחזירה את הצומת באינדקס הנתון מבין כל הצמתים שהם צאצאים ישירים של הצומת {@code Element}.
`getContentSize()`	`Integer`	הפונקציה מחזירה את מספר הצמתים שהם צאצאים ישירים של צומת {@code Element}.
`getDescendants()`	`Content[]`	מחזירה את כל הצמתים שהם צאצאים ישירים או עקיפים של צומת {@code Element}, לפי הסדר שבו הם מופיעים במסמך.
`getDocument()`	`Document`	מחזירה את מסמך ה-XML שמכיל את הצומת {@code Element}.
`getName()`	`String`	מחזירה את השם המקומי של הצומת `Element`.
`getNamespace()`	`Namespace`	הפונקציה מחזירה את מרחב השמות של הצומת `Element`.
`getNamespace(prefix)`	`Namespace`	קבלת מרחב השמות עם הקידומת הנתונה עבור הצומת `Element`.
`getParentElement()`	`Element\|null`	מקבל את צומת ההורה `Element` של הצומת.
`getQualifiedName()`	`String`	מחזירה את השם המקומי ואת קידומת מרחב השמות של הצומת `Element`, בצורה `[namespacePrefix]:[localName]`.
`getText()`	`String`	מקבלת את ערך הטקסט של הצומת `Element`.
`getValue()`	`String`	מחזירה את ערך הטקסט של כל הצמתים שהם צאצאים ישירים או עקיפים של הצומת, לפי הסדר שבו הם מופיעים במסמך.
`isAncestorOf(other)`	`Boolean`	הפונקציה קובעת אם הצומת `Element` הוא הורה ישיר או עקיף של הצומת `Element`.
`isRootElement()`	`Boolean`	קובע אם הצומת `Element` הוא צומת הבסיס של המסמך.
`removeAttribute(attribute)`	`Boolean`	מסיר את המאפיין שצוין מהצומת `Element`, אם מאפיין כזה קיים.
`removeAttribute(attributeName)`	`Boolean`	מסיר את המאפיין של הצומת `Element` הזה עם השם הנתון וללא מרחב שמות, אם קיים מאפיין כזה.
`removeAttribute(attributeName, namespace)`	`Boolean`	מסיר את המאפיין של הצומת `Element` עם השם ומרחב השמות שצוינו, אם קיים מאפיין כזה.
`removeContent()`	`Content[]`	הפונקציה מסירה את כל הצמתים שהם צמתים משניים מיידיים של צומת {@code Element}.
`removeContent(content)`	`Boolean`	מסירה את הצומת הנתון, אם הצומת הוא צאצא ישיר של צומת {@code Element}.
`removeContent(index)`	`Content\|null`	מסירה את הצומת באינדקס הנתון מבין כל הצמתים שהם צאצאים ישירים של הצומת {@code Element}.
`setAttribute(attribute)`	`Element`	הגדרה של המאפיין שצוין לצומת `Element` הזה.
`setAttribute(name, value)`	`Element`	מגדיר את המאפיין של צומת `Element` הזה עם השם, הערך ומרחב השמות שצוינו.
`setAttribute(name, value, namespace)`	`Element`	מגדיר את המאפיין של הצומת `Element` הזה עם השם, הערך ומרחב השמות שצוינו.
`setName(name)`	`Element`	מגדיר את השם המקומי של צומת `Element`.
`setNamespace(namespace)`	`Element`	מגדיר את מרחב השמות של הצומת `Element`.
`setText(text)`	`Element`	מגדירה את ערך הטקסט של הצומת `Element`.

תיעוד מפורט

`addContent(content)`

מוסיף את הצומת הנתון כצאצא האחרון של הצומת Element. הארגומנט content יכול להיות אובייקט Element או כל אובייקט צומת שמתאים לסוג שמופיע בContentType.

פרמטרים

שם	סוג	תיאור
`content`	`Content`	הצומת לצירוף.

חזרה

‫Element — הצומת Element, לשרשור.

`addContent(index, content)`

הפונקציה מוסיפה את הצומת הנתון באינדקס הנתון בין כל הצמתים שהם צאצאים ישירים של הצומת Element. הארגומנט content יכול להיות אובייקט Element או כל אובייקט צומת שמתאים לסוג שמופיע ב-ContentType.

פרמטרים

שם	סוג	תיאור
`index`	`Integer`	האינדקס שבו צריך להוסיף את הצומת בין כל הצמתים שהם צאצאים ישירים של הצומת `Element`.
`content`	`Content`	הצומת להוספה.

חזרה

‫Element — הצומת Element, לשרשור.

`cloneContent()`

יוצר עותקים לא מצורפים של כל הצמתים שהם צאצאים ישירים של צומת {@code Element}.

חזרה

‫Content[] — מערך של עותקים לא מצורפים של כל הצמתים שהם צאצאים ישירים של הצומת {@code Element}.

`detach()`

מנתק את הצומת מצומת ההורה Element. אם לצומת אין הורה, השיטה הזו לא משפיעה.

חזרה

‫Content|null – הצומת המנותק.

`getAllContent()`

מחזירה את כל הצמתים שהם צאצאים ישירים של צומת {@code Element}.

חזרה

‫Content[] — מערך של כל הצמתים שהם צאצאים ישירים של צומת {@code Element}.

`getAttribute(name)`

מחזירה את המאפיין של צומת Element הזה עם השם הנתון וללא מרחב שמות. אם לא קיים מאפיין כזה, השיטה הזו מחזירה null.

פרמטרים

שם	סוג	תיאור
`name`	`String`	שם המאפיין.

חזרה

‫Attribute|null – המאפיין, או null אם אין מאפיין עם השם שצוין ואין מרחב שמות.

`getAttribute(name, namespace)`

מחזירה את המאפיין של צומת Element הזה עם השם ומרחב השמות שצוינו. אם אין צומת כזה, השיטה הזו מחזירה null.

פרמטרים

שם	סוג	תיאור
`name`	`String`	שם המאפיין.
`namespace`	`Namespace`	מרחב השמות של המאפיין.

חזרה

‫Attribute|null – המאפיין, או null אם אין מאפיין עם השם ומרחב השמות שצוינו.

`getAttributes()`

מחזירה את כל המאפיינים של הצומת Element הזה, בסדר שבו הם מופיעים במסמך.

חזרה

‫Attribute[] — מערך של כל המאפיינים של צומת Element.

`getChild(name)`

מחזירה את הצומת הראשון Element עם השם הנתון וללא מרחב שמות, שהוא צאצא ישיר של הצומת Element. אם אין צומת כזה, השיטה הזו מחזירה null.

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם של צומת `Element` הילד.

חזרה

‫Element|null – הצומת Element, או null אם אין צומת צאצא מיידי Element עם השם הנתון ואין מרחב שמות.

`getChild(name, namespace)`

מחזירה את הצומת הראשון Element עם השם ומרחב השמות הנתונים, שהוא צאצא ישיר של הצומת Element הזה. אם אין צומת כזה, השיטה הזו מחזירה null.

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם של צומת `Element` הילד.
`namespace`	`Namespace`	מרחב השמות של צומת הצאצא `Element`.

חזרה

‫Element|null – הצומת Element או null אם אין צומת צאצא מיידי Element עם השם ומרחב השמות שצוינו.

`getChildText(name)`

הפונקציה מחזירה את ערך הטקסט של הצומת עם השם הנתון וללא מרחב שמות, אם הצומת הוא צאצא ישיר של הצומת Element. אם אין צומת כזה, השיטה הזו מחזירה null.

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם של צומת הצאצא.

חזרה

‫String|null – ערך הטקסט של צומת הצאצא, או null אם אין צומת צאצא מיידי עם השם הנתון ואין מרחב שמות.

`getChildText(name, namespace)`

מחזירה את ערך הטקסט של הצומת עם השם ומרחב השמות שצוינו, אם הצומת הוא צאצא ישיר של הצומת Element. אם אין צומת כזה, השיטה הזו מחזירה null.

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם של צומת הצאצא.
`namespace`	`Namespace`	מרחב השמות של צומת הצאצא.

חזרה

‫String|null – ערך הטקסט של צומת הצאצא, או null אם אין צומת צאצא מיידי עם השם ומרחב השמות שצוינו.

`getChildren()`

מחזירה את כל הצמתים מסוג Element שהם צמתים משניים ישירים של הצומת Element הזה, לפי הסדר שבו הם מופיעים במסמך.

חזרה

‫Element[] — מערך של כל הצמתים מסוג Element שהם צאצאים ישירים של הצומת הזה מסוג Element.

`getChildren(name)`

מחזירה את כל הצמתים Element עם השם הנתון וללא מרחב שמות, שהם צאצאים ישירים של הצומת Element הזה, לפי הסדר שבו הם מופיעים במסמך.

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם של הצמתים המשניים `Element`.

חזרה

‫Element[] – מערך של כל הצמתים Element עם השם הנתון וללא מרחב שמות, שהם צאצאים ישירים של הצומת Element הזה.

`getChildren(name, namespace)`

מחזירה את כל הצמתים Element עם השם ומרחב השמות שצוינו, שהם צאצאים ישירים של הצומת Element, לפי הסדר שבו הם מופיעים במסמך.

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם של צמתי הצאצא `Element`.
`namespace`	`Namespace`	מרחב השמות של הצמתים המשניים `Element`.

חזרה

‫Element[] – מערך של כל הצמתים Element עם השם ומרחב השמות שצוינו, שהם צמתים משניים מיידיים של הצומת Element הזה.

`getContent(index)`

מחזירה את הצומת באינדקס הנתון מבין כל הצמתים שהם צאצאים ישירים של הצומת {@code Element}. אם אין צומת באינדקס הנתון, השיטה הזו מחזירה null.

פרמטרים

שם	סוג	תיאור
`index`	`Integer`	האינדקס של הצומת בין כל הצמתים שהם צאצאים ישירים של הצומת {@code Element}.

חזרה

‫Content|null – הצומת, או null אם אין צומת באינדקס הנתון.

`getContentSize()`

הפונקציה מחזירה את מספר הצמתים שהם צאצאים ישירים של צומת {@code Element}.

חזרה

‫Integer – מספר הצמתים שהם צאצאים ישירים של צומת {@code Element}.

`getDescendants()`

מחזירה את כל הצמתים שהם צאצאים ישירים או עקיפים של צומת {@code Element}, לפי הסדר שבו הם מופיעים במסמך.

חזרה

‫Content[] – מערך של כל הצמתים שהם צאצאים ישירים או עקיפים של צומת {@code Element}.

`getDocument()`

מחזירה את מסמך ה-XML שמכיל את הצומת {@code Element}.

חזרה

‫Document – המסמך שמכיל את הצומת {@code Element}.

`getName()`

מחזירה את השם המקומי של הצומת Element. אם לצומת יש תחילית של מרחב שמות, משתמשים ב-getQualifiedName() או ב-getNamespace().‫getPrefix() כדי לקבל את הקידומת.

חזרה

‫String – השם המקומי של הצומת Element.

`getNamespace()`

הפונקציה מחזירה את מרחב השמות של הצומת Element.

חזרה

‫Namespace – מרחב השמות של הצומת Element.

`getNamespace(prefix)`

קבלת מרחב השמות עם הקידומת הנתונה עבור הצומת Element.

פרמטרים

שם	סוג	תיאור
`prefix`	`String`	הקידומת של מרחב השמות.

חזרה

‫Namespace – מרחב השמות עם הקידומת שצוינה לצומת Element.

`getParentElement()`

מקבל את צומת ההורה Element של הצומת. אם לצומת אין הורה, השיטה הזו מחזירה null.

חזרה

‫Element|null — צומת ההורה Element.

`getQualifiedName()`

מחזירה את השם המקומי ואת קידומת מרחב השמות של הצומת Element, בצורה [namespacePrefix]:[localName]. אם לצומת אין קידומת של מרחב שמות, משתמשים ב-getName().

חזרה

‫String – השם המקומי והקידומת של מרחב השמות של הצומת Element, בפורמט [namespacePrefix]:[localName].

`getText()`

מקבלת את ערך הטקסט של הצומת Element.

חזרה

‫String — ערך הטקסט של הצומת Element.

`getValue()`

מחזירה את ערך הטקסט של כל הצמתים שהם צאצאים ישירים או עקיפים של הצומת, לפי הסדר שבו הם מופיעים במסמך.

חזרה

‫String — ערך הטקסט של כל הצמתים שהם צאצאים ישירים או עקיפים של הצומת.

`isAncestorOf(other)`

הפונקציה קובעת אם הצומת Element הוא הורה ישיר או עקיף של הצומת Element.

פרמטרים

שם	סוג	תיאור
`other`	`Element`	צומת `Element` אחר.

חזרה

‫Boolean – true אם הצומת Element הזה הוא הורה ישיר או עקיף של הצומת Element הנתון; false אם לא.

`isRootElement()`

קובע אם הצומת Element הוא צומת הבסיס של המסמך.

חזרה

‫Boolean – true אם הצומת Element הוא צומת הבסיס של המסמך; false אם לא.

`removeAttribute(attribute)`

מסיר את המאפיין שצוין מהצומת Element, אם מאפיין כזה קיים.

פרמטרים

שם	סוג	תיאור
`attribute`	`Attribute`	המאפיין.

חזרה

‫Boolean — true אם המאפיין היה קיים והוסר; false אם לא.

`removeAttribute(attributeName)`

מסיר את המאפיין של הצומת Element הזה עם השם הנתון וללא מרחב שמות, אם קיים מאפיין כזה.

פרמטרים

שם	סוג	תיאור
`attributeName`	`String`	שם המאפיין.

חזרה

‫Boolean — true אם המאפיין היה קיים והוסר; false אם לא.

`removeAttribute(attributeName, namespace)`

מסיר את המאפיין של הצומת Element עם השם ומרחב השמות שצוינו, אם קיים מאפיין כזה.

פרמטרים

שם	סוג	תיאור
`attributeName`	`String`	שם המאפיין.
`namespace`	`Namespace`	מרחב השמות של המאפיין.

חזרה

‫Boolean — true אם המאפיין היה קיים והוסר; false אם לא.

`removeContent()`

הפונקציה מסירה את כל הצמתים שהם צמתים משניים מיידיים של צומת {@code Element}.

חזרה

‫Content[] — מערך של כל הצמתים שהיו צאצאים ישירים של צומת {@code Element} לפני שהוסרו.

`removeContent(content)`

מסירה את הצומת הנתון, אם הצומת הוא צאצא ישיר של צומת {@code Element}. הארגומנט content יכול להיות אובייקט Element או כל אובייקט צומת שתואם לסוג שמופיע ב-ContentType.

פרמטרים

שם	סוג	תיאור
`content`	`Content`	הצומת שרוצים להסיר.

חזרה

‫Boolean — true אם הצומת היה צאצא ישיר והוסר; false אם לא.

`removeContent(index)`

מסירה את הצומת באינדקס הנתון מבין כל הצמתים שהם צאצאים ישירים של הצומת {@code Element}. אם אין צומת באינדקס הנתון, השיטה הזו מחזירה null.

פרמטרים

שם	סוג	תיאור
`index`	`Integer`	האינדקס של הצומת בין כל הצמתים שהם צאצאים ישירים של הצומת {@code Element}.

חזרה

‫Content|null — הצומת שהוסר, או null אם אין צומת באינדקס הנתון.

`setAttribute(attribute)`

הגדרה של המאפיין שצוין לצומת Element הזה.

פרמטרים

שם	סוג	תיאור
`attribute`	`Attribute`	המאפיין שצריך להגדיר.

חזרה

‫Element — הצומת Element, לשרשור.

`setAttribute(name, value)`

מגדיר את המאפיין של צומת Element הזה עם השם, הערך ומרחב השמות שצוינו.

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם של המאפיין שרוצים להגדיר.
`value`	`String`	הערך של המאפיין שצריך להגדיר.

חזרה

‫Element — הצומת Element, לשרשור.

`setAttribute(name, value, namespace)`

מגדיר את המאפיין של הצומת Element הזה עם השם, הערך ומרחב השמות שצוינו.

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם של המאפיין שרוצים להגדיר.
`value`	`String`	הערך של המאפיין שצריך להגדיר.
`namespace`	`Namespace`	מרחב השמות של המאפיין שרוצים להגדיר.

חזרה

‫Element — הצומת Element, לשרשור.

`setName(name)`

מגדיר את השם המקומי של צומת Element. כדי להגדיר קידומת למרחב שמות עבור הצומת, משתמשים ב-setNamespace(namespace) יחד עם XmlService.getNamespace(prefix, uri).

פרמטרים

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

חזרה

‫Element — הצומת Element, לשרשור.

`setNamespace(namespace)`

מגדיר את מרחב השמות של הצומת Element.

פרמטרים

שם	סוג	תיאור
`namespace`	`Namespace`	מרחב השמות להגדרה.

חזרה

‫Element — הצומת Element, לשרשור.

`setText(text)`

מגדירה את ערך הטקסט של הצומת Element. אם הצומת כבר מכיל ערך טקסט או צמתים צאצאים, השיטה הזו מחליפה את התוכן הישן. כדי להוסיף תוכן או להכניס תוכן במקום זאת, צריך להשתמש ב-addContent(content) או ב-addContent(index, content).

פרמטרים

שם	סוג	תיאור
`text`	`String`	הטקסט שרוצים להגדיר.

חזרה

‫Element — הצומת Element, לשרשור.

Class Element קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

Methods

תיעוד מפורט

addContent(content)

פרמטרים

חזרה

addContent(index, content)

פרמטרים

חזרה

cloneContent()

חזרה

detach()

חזרה

getAllContent()

חזרה

getAttribute(name)

פרמטרים

חזרה

getAttribute(name, namespace)

פרמטרים

חזרה

getAttributes()

חזרה

getChild(name)

פרמטרים

חזרה

getChild(name, namespace)

פרמטרים

חזרה

getChildText(name)

פרמטרים

חזרה

getChildText(name, namespace)

פרמטרים

חזרה

getChildren()

חזרה

getChildren(name)

פרמטרים

חזרה

getChildren(name, namespace)

פרמטרים

חזרה

getContent(index)

פרמטרים

חזרה

getContentSize()

חזרה

getDescendants()

חזרה

getDocument()

חזרה

getName()

חזרה

getNamespace()

חזרה

getNamespace(prefix)

פרמטרים

חזרה

getParentElement()

חזרה

getQualifiedName()

חזרה

getText()

חזרה

getValue()

חזרה

isAncestorOf(other)

פרמטרים

חזרה

isRootElement()

חזרה

removeAttribute(attribute)

פרמטרים

חזרה

removeAttribute(attributeName)

פרמטרים

חזרה

removeAttribute(attributeName, namespace)

פרמטרים

Class Element

`addContent(content)`

`addContent(index, content)`

`cloneContent()`

`detach()`

`getAllContent()`

`getAttribute(name)`

`getAttribute(name, namespace)`

`getAttributes()`

`getChild(name)`

`getChild(name, namespace)`

`getChildText(name)`

`getChildText(name, namespace)`

`getChildren()`

`getChildren(name)`

`getChildren(name, namespace)`

`getContent(index)`

`getContentSize()`

`getDescendants()`

`getDocument()`

`getName()`

`getNamespace()`

`getNamespace(prefix)`

`getParentElement()`

`getQualifiedName()`

`getText()`

`getValue()`

`isAncestorOf(other)`

`isRootElement()`

`removeAttribute(attribute)`

`removeAttribute(attributeName)`

`removeAttribute(attributeName, namespace)`

`removeContent()`

`removeContent(content)`

`removeContent(index)`

`setAttribute(attribute)`

`setAttribute(name, value)`

`setAttribute(name, value, namespace)`

`setName(name)`

`setNamespace(namespace)`

`setText(text)`