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

روش‌ها

روش نوع بازگشتی شرح مختصر
add Content(content) Element گره داده شده را به عنوان آخرین فرزند گره Element اضافه می‌کند.
add Content(index, content) Element گره داده شده را در اندیس داده شده، در بین تمام گره‌هایی که فرزند بلافصل گره Element هستند، درج می‌کند.
clone Content() Content[] کپی‌های غیراتصالی از تمام گره‌هایی که فرزند بلافصل گره {@code Element} هستند، ایجاد می‌کند.
detach() Content |null گره را از گره Element والدش جدا می‌کند.
get All Content() Content[] تمام گره‌هایی که فرزند بلافصل گره {@code Element} هستند را برمی‌گرداند.
get Attribute(name) Attribute |null ویژگی این گره Element را با نام داده شده و بدون فضای نام دریافت می‌کند.
get Attribute(name, namespace) Attribute |null ویژگی این گره Element را با نام و فضای نام داده شده دریافت می‌کند.
get Attributes() Attribute[] تمام ویژگی‌های این گره Element را به ترتیبی که در سند ظاهر می‌شوند، دریافت می‌کند.
get Child(name) Element |null اولین گره Element ) را با نام داده شده و بدون فضای نامی که فرزند بلافصل این گره Element باشد، برمی‌گرداند.
get Child(name, namespace) Element |null اولین گره Element را با نام و فضای نام داده شده که فرزند بلافصل این گره Element است، برمی‌گرداند.
get Child Text(name) String|null اگر گره، فرزند بلافصل گره Element باشد، مقدار متنی گره با نام داده شده و بدون فضای نام را برمی‌گرداند.
get Child Text(name, namespace) String|null اگر گره، فرزند بلافصل گره Element باشد، مقدار متنی گره را با نام و فضای نام داده شده برمی‌گرداند.
get Children() Element[] تمام گره‌های Element که فرزندان بلافصل این گره Element هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
get Children(name) Element[] تمام گره‌های Element با نام داده شده و بدون فضای نام (namespace) که فرزندان بلافصل این گره Element node) هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
get Children(name, namespace) Element[] تمام گره‌های Element با نام و فضای نام داده شده که فرزندان بلافصل این گره Element هستند را به ترتیبی که در سند ظاهر می‌شوند، دریافت می‌کند.
get Content(index) Content |null گره‌ای را که در اندیس داده شده قرار دارد، از بین تمام گره‌هایی که فرزند بلافصل گره {@code Element} هستند، برمی‌گرداند.
get Content Size() Integer تعداد گره‌هایی که فرزند بلافصل گره {@code Element} هستند را برمی‌گرداند.
get Descendants() Content[] تمام گره‌هایی که فرزندان مستقیم یا غیرمستقیم گره {@code Element} هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
get Document() Document سند XML که شامل گره {@code Element} است را دریافت می‌کند.
get Name() String نام محلی گره Element را برمی‌گرداند.
get Namespace() Namespace فضای نام (namespace) مربوط به گره Element را دریافت می‌کند.
get Namespace(prefix) Namespace فضای نامی را با پیشوند داده شده برای گره Element دریافت می‌کند.
get Parent Element() Element |null گره Element والد گره را دریافت می‌کند.
get Qualified Name() String نام محلی و پیشوند فضای نام گره Element را به شکل [namespacePrefix]:[localName] دریافت می‌کند.
get Text() String مقدار متن گره Element را دریافت می‌کند.
get Value() String مقدار متن تمام گره‌هایی که فرزندان مستقیم یا غیرمستقیم گره هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.
is Ancestor Of(other) Boolean مشخص می‌کند که آیا این گره Element والد مستقیم یا غیرمستقیم یک گره Element مشخص است یا خیر.
is Root Element() Boolean تعیین می‌کند که آیا گره Element ، گره ریشه سند است یا خیر.
remove Attribute(attribute) Boolean در صورت وجود، ویژگی داده شده برای این گره Element را حذف می‌کند.
remove Attribute(attributeName) Boolean ویژگی این گره Element را با نام داده شده و بدون فضای نام، در صورت وجود، حذف می‌کند.
remove Attribute(attributeName, namespace) Boolean ویژگی این گره Element با نام و فضای نام داده شده را در صورت وجود، حذف می‌کند.
remove Content() Content[] تمام گره‌هایی که فرزند بلافصل گره {@code Element} هستند را حذف می‌کند.
remove Content(content) Boolean اگر گره، فرزند بلافصل گره {@code Element} باشد، گره داده شده را حذف می‌کند.
remove Content(index) Content |null گره‌ای را که در اندیس داده شده قرار دارد، از بین تمام گره‌هایی که فرزند بلافصل گره {@code Element} هستند، حذف می‌کند.
set Attribute(attribute) Element ویژگی داده شده را برای این گره Element تنظیم می‌کند.
set Attribute(name, value) Element ویژگی این گره Element را با نام و مقدار داده شده و بدون فضای نام تنظیم می‌کند.
set Attribute(name, value, namespace) Element ویژگی این گره Element را با نام، مقدار و فضای نام داده شده تنظیم می‌کند.
set Name(name) Element نام محلی گره Element را تنظیم می‌کند.
set Namespace(namespace) Element فضای نام را برای گره Element تنظیم می‌کند.
set Text(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 ، یا اگر هیچ گره Element فرزند بی‌واسطه‌ای با نام داده شده و فضای نامی وجود نداشته باشد، null .

getChild(name, namespace)

اولین گره Element را با نام و فضای نام داده شده که فرزند بلافصل این گره Element است، برمی‌گرداند. اگر چنین گره‌ای وجود نداشته باشد، این متد null را برمی‌گرداند.

پارامترها

نام نوع توضیحات
name String نام گره Element فرزند.
namespace Namespace فضای نام گره Element فرزند.

بازگشت

Element |null — گره Element ، یا اگر هیچ گره Element فرزند بی‌واسطه‌ای با نام و فضای نام داده شده وجود نداشته باشد، null .

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 با نام داده شده و بدون فضای نام (namespace) که فرزندان بلافصل این گره Element node) هستند را به ترتیبی که در سند ظاهر می‌شوند، برمی‌گرداند.

پارامترها

نام نوع توضیحات
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()

فضای نام (namespace) مربوط به گره 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 - اگر این گره Element ، والد مستقیم یا غیرمستقیم گره Element داده شده باشد، true و در غیر این صورت، false برمی‌گرداند.

isRootElement()

تعیین می‌کند که آیا گره Element ، گره ریشه سند است یا خیر.

بازگشت

Boolean - اگر گره Element ، گره ریشه سند باشد، true و در غیر این صورت، false .

removeAttribute(attribute)

در صورت وجود، ویژگی داده شده برای این گره Element را حذف می‌کند.

پارامترها

نام نوع توضیحات
attribute Attribute ویژگی.

بازگشت

Boolean - اگر ویژگی وجود داشته و حذف شده باشد، true و در غیر این صورت false برمی‌گرداند.

removeAttribute(attributeName)

ویژگی این گره Element را با نام داده شده و بدون فضای نام، در صورت وجود، حذف می‌کند.

پارامترها

نام نوع توضیحات
attribute Name String نام ویژگی.

بازگشت

Boolean - اگر ویژگی وجود داشته و حذف شده باشد، true و در غیر این صورت false برمی‌گرداند.

removeAttribute(attributeName, namespace)

ویژگی این گره Element با نام و فضای نام داده شده را در صورت وجود، حذف می‌کند.

پارامترها

نام نوع توضیحات
attribute Name 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 ، برای زنجیره‌سازی.