Class Element

العنصر

تمثّل هذه السمة عقدة Element بتنسيق XML.

// 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 هي العقدة الجذرية للمستند.
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 هي العقدة الجذرية للمستند.

الإرجاع

Booleantrue إذا كانت العقدة Element هي العقدة الجذرية للمستند، 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، للتسلسل