Class Element

רכיב

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

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

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
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. אם לצומת אין הורה, לשיטה הזו אין השפעה.

החזרות

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, לשרשור