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

المَعلمات

الاسمTypeالوصف
contentContentالعقدة لإلحاقها

استرجاع الكرة

Element - العقدة Element، للسلاسل


addContent(index, content)

لإدراج العقدة المحددة في الفهرس المحدد بين جميع العُقد الثانوية المباشرة للعقدة Element. يمكن أن تكون الوسيطة content كائن Element أو أي كائن عقدة يتوافق مع أحد الأنواع المدرَجة في ContentType.

المَعلمات

الاسمTypeالوصف
indexIntegerالفهرس الذي يتم فيه إدراج العقدة بين جميع العُقد الثانوية المباشرة للعقدة Element
contentContentالعقدة لإدراج

استرجاع الكرة

Element - العقدة Element، للسلاسل


cloneContent()

تنشئ نُسخًا غير مرتبطة بجميع العُقد التي تشكّل عناصر ثانوية مباشرة للعقدة {@code Element}.

استرجاع الكرة

Content[] - مصفوفة من النُسخ غير المرتبطة بجميع العُقد الثانوية المباشرة للعقدة {@code Element}


detach()

لفصل العقدة عن عقدة Element الرئيسية إذا لم يكن لهذه العقدة عنصر رئيسي، فلن يكون لهذه الطريقة أي تأثير.

استرجاع الكرة

Content: العقدة المنفصلة


getAllContent()

للحصول على جميع العُقد الثانوية المباشرة للعقدة {@code Element}.

استرجاع الكرة

Content[] — مصفوفة من جميع العُقد الثانوية المباشرة للعقدة {@code Element}


getAttribute(name)

يتم الحصول على السمة لعقدة Element هذه باستخدام الاسم المعني وبدون مساحة اسم. وفي حال عدم وجود مثل هذا التصنيف، تعرض هذه الطريقة القيمة null.

المَعلمات

الاسمTypeالوصف
nameStringاسم السمة

استرجاع الكرة

Attribute: السمة أو null في حال عدم توفُّر سمة بالاسم المحدّد وبدون مساحة اسم


getAttribute(name, namespace)

يتم الحصول على السمة لعقدة Element هذه باستخدام الاسم ومساحة الاسم المحدّدة. في حال عدم وجود مثل هذا الجزء، تعرض هذه الطريقة null.

المَعلمات

الاسمTypeالوصف
nameStringاسم السمة
namespaceNamespaceمساحة الاسم للسمة

استرجاع الكرة

Attribute: السمة أو null في حال عدم توفُّر سمة باسم ومساحة الاسم المحدّدة


getAttributes()

الحصول على جميع السمات لعقدة Element هذه بالترتيب الذي تظهر به في المستند

استرجاع الكرة

Attribute[]: مصفوفة من جميع السمات لهذه العقدة Element


getChild(name)

الحصول على أول عقدة Element بالاسم المحدد بدون مساحة اسم تابعة مباشرة لعقدة Element هذه. في حال عدم وجود مثل هذا الجزء، تعرض هذه الطريقة القيمة null.

المَعلمات

الاسمTypeالوصف
nameStringاسم عقدة Element الفرعية

استرجاع الكرة

Element: العقدة Element أو null في حال عدم وجود عقدة Element ثانوية مباشرة تحمل الاسم المحدّد وبدون مساحة اسم


getChild(name, namespace)

الحصول على أول عقدة Element ذات اسم ومساحة اسم محدَّدة تمثل عنصر ثانوي مباشر لعقدة Element هذه في حال عدم وجود مثل هذا الجزء، تعرض هذه الطريقة القيمة null.

المَعلمات

الاسمTypeالوصف
nameStringاسم عقدة Element الفرعية
namespaceNamespaceمساحة الاسم لعقدة Element الفرعية

استرجاع الكرة

Element: العقدة Element أو null في حال عدم وجود عقدة Element ثانوية مباشرة باسم ومساحة الاسم المحدّدة


getChildText(name)

للحصول على القيمة النصية للعقدة مع الاسم المحدد بدون مساحة اسم، إذا كانت العقدة فرعية مباشرًا للعقدة Element وفي حال عدم وجود مثل هذا الجزء، تعرض هذه الطريقة القيمة null.

المَعلمات

الاسمTypeالوصف
nameStringاسم العقدة الفرعية

استرجاع الكرة

String: القيمة النصية للعقدة الفرعية أو null في حال عدم وجود عقدة فرعية مباشرة بالاسم المحدّد وبدون مساحة اسم


getChildText(name, namespace)

للحصول على القيمة النصية للعقدة مع الاسم ومساحة الاسم المحددة، إذا كانت العقدة تابعة مباشرةً للعقدة Element في حال عدم وجود مثل هذا الجزء، تعرض هذه الطريقة القيمة null.

المَعلمات

الاسمTypeالوصف
nameStringاسم العقدة الفرعية
namespaceNamespaceمساحة الاسم للعقدة الفرعية

استرجاع الكرة

String: القيمة النصية للعقدة الفرعية أو null في حال عدم وجود عقدة فرعية مباشرة تحمل الاسم المحدّد ومساحة الاسم


getChildren()

الحصول على جميع عُقد Element الثانوية المباشرة لعقدة Element هذه بالترتيب الذي تظهر به في المستند

استرجاع الكرة

Element[]: مصفوفة من جميع العُقد البالغ عددها Element والتي تشكّل عناصر ثانوية مباشرة لهذه العقدة Element


getChildren(name)

الحصول على جميع عُقد Element بالاسم المحدّد وبدون مساحة اسم ضِمن هذه العُقدة Element، بالترتيب الذي تظهر به في المستند

المَعلمات

الاسمTypeالوصف
nameStringاسم عُقد Element الثانوية

استرجاع الكرة

Element[]: مصفوفة من جميع عُقد Element بالاسم المحدّد بدون مساحة اسم عناصر ثانوية مباشرة لعقدة Element هذه


getChildren(name, namespace)

الحصول على جميع عُقد Element ذات الاسم المحدّد ومساحة الاسم التي تمثّل عناصر ثانوية مباشرة لعقدة Element هذه بالترتيب الذي تظهر به في المستند

المَعلمات

الاسمTypeالوصف
nameStringاسم عُقد Element الثانوية
namespaceNamespaceمساحة الاسم لعُقد Element الفرعية

استرجاع الكرة

Element[]: مصفوفة من جميع عُقد Element ذات اسم ومساحة اسم معيّنة، وهي عناصر ثانوية مباشرة لعقدة Element هذه


getContent(index)

للحصول على العقدة في الفهرس المحدد بين جميع العُقد الثانوية المباشرة للعقدة {@code Element}. في حال عدم وجود عقدة في الفهرس المحدد، تعرض هذه الطريقة القيمة null.

المَعلمات

الاسمTypeالوصف
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.

المَعلمات

الاسمTypeالوصف
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 معيّنة.

المَعلمات

الاسمTypeالوصف
otherElementالعقدة الأخرى من فئة Element

استرجاع الكرة

Boolean: true إذا كانت عقدة Element هذه تابعة بشكل مباشر أو غير مباشر لعقدة Element المحدّدة، وfalse إذا لم تكن كذلك


isRootElement()

تحدِّد هذه السياسة ما إذا كانت العقدة Element هي العقدة الجذر للمستند.

استرجاع الكرة

Boolean: true إذا كانت العقدة Element هي العقدة الجذر للمستند، وfalse في حال عدم ظهورها


removeAttribute(attribute)

تزيل السمة المحدّدة لعقدة Element هذه في حال توفُّرها.

المَعلمات

الاسمTypeالوصف
attributeAttributeالسمة

استرجاع الكرة

Boolean: true في حال توفُّر السمة وتمت إزالتها، وfalse في حال عدم توفّرها


removeAttribute(attributeName)

تزيل سمة عقدة Element هذه ذات الاسم المحدّد بدون مساحة اسم، في حال توفّر هذه السمة.

المَعلمات

الاسمTypeالوصف
attributeNameStringاسم السمة

استرجاع الكرة

Boolean: true في حال توفُّر السمة وتمت إزالتها، وfalse في حال عدم توفّرها


removeAttribute(attributeName, namespace)

تزيل سمة عقدة Element هذه ذات الاسم ومساحة الاسم، في حال توفّرت السمة.

المَعلمات

الاسمTypeالوصف
attributeNameStringاسم السمة
namespaceNamespaceمساحة الاسم للسمة

استرجاع الكرة

Boolean: true في حال توفُّر السمة وتمت إزالتها، وfalse في حال عدم توفّرها


removeContent()

لإزالة جميع العُقد الثانوية المباشرة للعقدة {@code Element}.

استرجاع الكرة

Content[] — مصفوفة من جميع العُقد التي كانت عناصر ثانوية مباشرة للعقدة {@code Element} قبل إزالتها


removeContent(content)

لإزالة العقدة المحددة، إذا كانت العقدة ثانوية مباشرة للعقدة {@code Element}. يمكن أن تكون الوسيطة content كائن Element أو أي كائن عقدة يتوافق مع أحد الأنواع المدرَجة في ContentType.

المَعلمات

الاسمTypeالوصف
contentContentالعقدة لإزالتها

استرجاع الكرة

Boolean: true إذا كانت العقدة ثانوية مباشرة وتمت إزالتها، وfalse إذا لم تكن


removeContent(index)

لإزالة العقدة الموجودة في الفهرس المحدد بين جميع العُقد الثانوية المباشرة للعقدة {@code Element}. في حال عدم وجود عقدة في الفهرس المحدد، تعرض هذه الطريقة القيمة null.

المَعلمات

الاسمTypeالوصف
indexIntegerفهرس العقدة بين جميع العُقد الثانوية المباشرة للعقدة {@code Element}

استرجاع الكرة

Content: العقدة التي تمت إزالتها، أو null في حال عدم وجود عقدة في الفهرس المحدَّد


setAttribute(attribute)

لضبط السمة المحدّدة لعقدة Element هذه.

المَعلمات

الاسمTypeالوصف
attributeAttributeالسمة لتعيين

استرجاع الكرة

Element - العقدة Element، للسلاسل


setAttribute(name, value)

لضبط السمة لعقدة Element هذه باستخدام الاسم والقيمة بدون مساحة اسم

المَعلمات

الاسمTypeالوصف
nameStringاسم السمة لتعيين
valueStringقيمة التصنيف المطلوب تعيينها

استرجاع الكرة

Element - العقدة Element، للسلاسل


setAttribute(name, value, namespace)

لضبط السمة لعقدة Element هذه باستخدام الاسم والقيمة ومساحة الاسم المحدّدة.

المَعلمات

الاسمTypeالوصف
nameStringاسم السمة لتعيين
valueStringقيمة التصنيف المطلوب تعيينها
namespaceNamespaceمساحة اسم السمة المطلوب تعيينها

استرجاع الكرة

Element - العقدة Element، للسلاسل


setName(name)

لضبط الاسم المحلي للعقدة Element. لضبط بادئة مساحة الاسم للعقدة، استخدِم setNamespace(namespace) بالاقتران مع XmlService.getNamespace(prefix, uri).

المَعلمات

الاسمTypeالوصف
nameStringالاسم المحلي لتعيين

استرجاع الكرة

Element - العقدة Element، للسلاسل


setNamespace(namespace)

تضبط مساحة الاسم لعقدة Element.

المَعلمات

الاسمTypeالوصف
namespaceNamespaceمساحة الاسم المطلوب تعيينها

استرجاع الكرة

Element - العقدة Element، للسلاسل


setText(text)

لضبط القيمة النصية للعقدة Element. إذا كانت العقدة تحتوي على قيمة نصية أو أي عُقد فرعية، فإن هذه الطريقة ستستبدل المحتوى القديم. لإلحاق محتوى أو إدراجه بدلاً من ذلك، استخدِم addContent(content) أو addContent(index, content).

المَعلمات

الاسمTypeالوصف
textStringالنص المطلوب تعيينه

استرجاع الكرة

Element - العقدة Element، للسلاسل