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تؤدي هذه العملية إلى فصل العقدة عن العقدة الرئيسية 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 التي تحمل الاسم ومساحة الاسم المحدّدة وتكون فرعية مباشرةً لnode 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.

المعلمات

الاسمالنوعالوصف
contentContentالعقدة التي تريد إضافتها

الإرجاع

Element: عقدة Element لإنشاء سلاسل


addContent(index, content)

تُدرج هذه الدالة العقدة المحدّدة في الفهرس المحدّد بين جميع العقد التي هي عناصر ثانوية مباشرة للعقدة Element. يمكن أن تكون وسيطة content عنصرًا من النوع Element أو أي عنصر node يتطابق مع نوع مُدرَج في 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 التي تحمل الاسم ومساحة الاسم المحدّدة وتكون فرعية مباشرةً لnode 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 هي العقدة الجذر للمستند.

الإرجاع

Booleantrue إذا كانت العقدة 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العقدة المطلوب إزالتها

الإرجاع

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 لإنشاء سلاسل