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	ניתוק הצומת מצומת ההורה Element.
getAllContent()	Content[]	הפונקציה מקבלת את כל הצמתים שהם צאצאים מיידיים של הצומת {@code Element}.
getAttribute(name)	Attribute	הפונקציה מקבלת את המאפיין של צומת Element הזה עם השם שצוין, ללא מרחב שמות.
getAttribute(name, namespace)	Attribute	הפונקציה מקבלת את המאפיין של צומת Element הזה עם השם ומרחב השמות שצוינו.
getAttributes()	Attribute[]	הפונקציה מקבלת את כל המאפיינים של הצומת Element הזה, לפי הסדר שבו הם מופיעים במסמך.
getChild(name)	Element	הפונקציה מקבלת את צומת ה-Element הראשון עם השם שצוין, ללא מרחב שמות, שהוא צאצא ישיר של צומת ה-Element הזה.
getChild(name, namespace)	Element	הפונקציה מקבלת את הצומת Element הראשון עם השם והמרחב השם שצוינו, שהוא צאצא ישיר של הצומת Element הזה.
getChildText(name)	String	הפונקציה מקבלת את ערך הטקסט של הצומת עם השם הנתון ללא מרחב שמות, אם הצומת הוא צאצא מיידי של הצומת Element.
getChildText(name, namespace)	String	הפונקציה מקבלת את ערך הטקסט של הצומת עם השם ומרחב השמות שצוינו, אם הצומת הוא צאצא ישיר של הצומת Element.
getChildren()	Element[]	הפונקציה מקבלת את כל צמתים ה-Element שהם צאצאים מיידיים של צומת ה-Element הזה, לפי הסדר שבו הם מופיעים במסמך.
getChildren(name)	Element[]	הפונקציה מקבלת את כל צומתי ה-Element עם השם שצוין, ללא מרחב שמות, שהם צאצאים מיידיים של צומת ה-Element הזה, לפי הסדר שבו הם מופיעים במסמך.
getChildren(name, namespace)	Element[]	הפונקציה מקבלת את כל צמתים ה-Element עם השם ומרחב השמות שצוינו, שהם צאצאים מיידיים של צומת ה-Element הזה, לפי הסדר שבו הם מופיעים במסמך.
getContent(index)	Content	הפונקציה מקבלת את הצומת שמופיע באינדקס הנתון מבין כל הצמתים שהם צאצאים מיידיים של הצומת {@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	הפונקציה מקבלת את צומת ההורה 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	הסרת הצומת במדד הנתון מבין כל הצמתים שהם צאצאים מיידיים של הצומת {@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. אם לצומת אין הורה, ל-method הזו אין השפעה.

חזרה

Content – הצומת המנותק

---

getAllContent()

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

חזרה

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

---

getAttribute(name)

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

פרמטרים

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

חזרה

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

---

getAttribute(name, namespace)

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

פרמטרים

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

חזרה

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

---

getAttributes()

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

חזרה

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

---

getChild(name)

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

פרמטרים

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

חזרה

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

---

getChild(name, namespace)

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

פרמטרים

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

חזרה

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

---

getChildText(name)

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

פרמטרים

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

חזרה

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

---

getChildText(name, namespace)

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

פרמטרים

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

חזרה

String – ערך הטקסט של צומת הצאצא, או 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 אם אין צומת באינדקס הנתון

---

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 – צומת ההורה 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 אם אין צומת באינדקס הנתון

---

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, לצורך קישור