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.

المعلمات

الاسمالنوعالوصف
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، للسلسلة