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);

الطُرق

الطريقة	نوع القيمة التي تم إرجاعها	وصف قصير
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، للسلسلة