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 הוא צומת הרמה הבסיסית (root) של המסמך.
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.

פרמטרים

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

חזרה

Element – הצומת Element, לשרשור


addContent(index, content)

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

פרמטרים

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

חזרה

Element – הצומת Element, לשרשור


cloneContent()

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

חזרה

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


detach()

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

חזרה

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


getAllContent()

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

חזרה

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


getAttribute(name)

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

פרמטרים

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

חזרה

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


getAttribute(name, namespace)

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

פרמטרים

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

חזרה

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


getAttributes()

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

חזרה

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


getChild(name)

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

פרמטרים

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

חזרה

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


getChild(name, namespace)

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

פרמטרים

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

חזרה

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


getChildText(name)

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

פרמטרים

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

חזרה

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


getChildText(name, namespace)

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

פרמטרים

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

חזרה

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


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 – צומת ההורה Element


getQualifiedName()

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

חזרה

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


getText()

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

חזרה

String – ערך הטקסט של הצומת Element


getValue()

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

חזרה

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


isAncestorOf(other)

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

פרמטרים

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

חזרה

Booleantrue אם הצומת Element הוא הורה ישיר או עקיף של ההורה הנתון צומת Element; false אם לא


isRootElement()

המדיניות קובעת אם הצומת Element הוא צומת הרמה הבסיסית (root) של המסמך.

חזרה

Booleantrue אם הצומת Element הוא צומת הרמה הבסיסית (root) של המסמך; false אם לא


removeAttribute(attribute)

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

פרמטרים

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

חזרה

Booleantrue אם המאפיין היה קיים והוסר. false אם לא


removeAttribute(attributeName)

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

פרמטרים

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

חזרה

Booleantrue אם המאפיין היה קיים והוסר. false אם לא


removeAttribute(attributeName, namespace)

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

פרמטרים

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

חזרה

Booleantrue אם המאפיין היה קיים והוסר. false אם לא


removeContent()

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

חזרה

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


removeContent(content)

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

פרמטרים

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

חזרה

Booleantrue אם הצומת היה צאצא מיידי והוא הוסר; false אם לא


removeContent(index)

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

פרמטרים

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

חזרה

Content – הצומת שהוסר, או 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, לשרשור