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. contentElementהארגומנט יכול להיות אובייקט Element או כל אובייקט צומת שמתאים לסוג שמופיע בContentType.

פרמטרים

שםסוגתיאור
contentContentהצומת לצירוף.

חזרה

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

addContent(index, content)

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

פרמטרים

שםסוגתיאור
indexIntegerהאינדקס שבו צריך להוסיף את הצומת בין כל הצמתים שהם צאצאים ישירים של צומת Element.
contentContentהצומת להוספה.

חזרה

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

cloneContent()

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

חזרה

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

detach()

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

חזרה

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

getAllContent()

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

חזרה

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

getAttribute(name)

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

פרמטרים

שםסוגתיאור
nameStringשם המאפיין.

חזרה

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

getAttribute(name, namespace)

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

פרמטרים

שםסוגתיאור
nameStringשם המאפיין.
namespaceNamespaceמרחב השמות של המאפיין.

חזרה

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

getAttributes()

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

חזרה

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

getChild(name)

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

פרמטרים

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

חזרה

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

getChild(name, namespace)

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

פרמטרים

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

חזרה

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

getChildText(name)

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

פרמטרים

שםסוגתיאור
nameStringהשם של צומת הצאצא.

חזרה

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

getChildText(name, namespace)

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

פרמטרים

שםסוגתיאור
nameStringהשם של צומת הצאצא.
namespaceNamespaceמרחב השמות של צומת הצאצא.

חזרה

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

getChildren()

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

חזרה

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

getChildren(name)

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

פרמטרים

שםסוגתיאור
nameStringהשם של צמתי הצאצא Element.

חזרה

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

getChildren(name, namespace)

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

פרמטרים

שםסוגתיאור
nameStringהשם של צמתי הצאצא Element.
namespaceNamespaceמרחב השמות של הצמתים המשניים Element.

חזרה

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

getContent(index)

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

פרמטרים

שםסוגתיאור
indexIntegerהאינדקס של הצומת בין כל הצמתים שהם צאצאים ישירים של הצומת {@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.

פרמטרים

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

חזרה

‫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.

פרמטרים

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

חזרה

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

isRootElement()

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

חזרה

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

removeAttribute(attribute)

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

פרמטרים

שםסוגתיאור
attributeAttributeהמאפיין.

חזרה

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

removeAttribute(attributeName)

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

פרמטרים

שםסוגתיאור
attributeNameStringשם המאפיין.

חזרה

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

removeAttribute(attributeName, namespace)

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

פרמטרים

שםסוגתיאור
attributeNameStringשם המאפיין.
namespaceNamespaceמרחב השמות של המאפיין.

חזרה

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

removeContent()

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

חזרה

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

removeContent(content)

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

פרמטרים

שםסוגתיאור
contentContentהצומת שרוצים להסיר.

חזרה

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

removeContent(index)

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

פרמטרים

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

חזרה

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

setAttribute(attribute)

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

פרמטרים

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

חזרה

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

setAttribute(name, value)

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

פרמטרים

שםסוגתיאור
nameStringהשם של המאפיין שרוצים להגדיר.
valueStringהערך של המאפיין שצריך להגדיר.

חזרה

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

setAttribute(name, value, namespace)

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

פרמטרים

שםסוגתיאור
nameStringהשם של המאפיין שרוצים להגדיר.
valueStringהערך של המאפיין שצריך להגדיר.
namespaceNamespaceמרחב השמות של המאפיין שרוצים להגדיר.

חזרה

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

setName(name)

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

פרמטרים

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

חזרה

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

setNamespace(namespace)

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

פרמטרים

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

חזרה

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

setText(text)

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

פרמטרים

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

חזרה

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