نمایشی از یک گره 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
مطابقت دارد.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
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()
getAllContent()
همه گره هایی را که فرزندان مستقیم گره {@code Element} هستند را دریافت می کند.
برگشت
Content[]
- آرایهای از همه گرههایی که فرزندان مستقیم گره {@code Element} هستند
getAttribute(name)
ویژگی این گره Element
را با نام داده شده و بدون فضای نام دریافت می کند. اگر چنین ویژگی وجود نداشته باشد، این متد null
را برمیگرداند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
name | String | نامی از مشخصات |
برگشت
Attribute
- مشخصه، یا اگر هیچ ویژگی با نام داده شده و فضای نام وجود نداشته باشد، null
getAttribute(name, namespace)
ویژگی این گره Element
را با نام و فضای نام داده شده دریافت می کند. اگر چنین گره ای وجود نداشته باشد، این متد null
را برمی گرداند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
name | String | نامی از مشخصات |
namespace | Namespace | فضای نام صفت |
برگشت
Attribute
- مشخصه، یا اگر ویژگی با نام و فضای نام داده شده وجود نداشته باشد، null
getAttributes()
تمام ویژگیهای این گره Element
را به ترتیبی که در سند ظاهر میشوند، دریافت میکند.
برگشت
Attribute[]
- آرایه ای از تمام ویژگی ها برای این گره Element
getChild(name)
اولین گره Element
را با نام داده شده و بدون فضای نام که فرزند مستقیم این گره Element
است، دریافت می کند. اگر چنین گره ای وجود نداشته باشد، این متد null
را برمی گرداند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
name | String | نام گره Element فرزند |
برگشت
Element
- گره Element
، یا اگر هیچ گره Element
فرزند فوری با نام داده شده و بدون فضای نام وجود نداشته باشد، null
.
getChild(name, namespace)
اولین گره Element
را با نام و فضای نام داده شده دریافت می کند که فرزند مستقیم این گره Element
است. اگر چنین گره ای وجود نداشته باشد، این متد null
را برمی گرداند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
name | String | نام گره Element فرزند |
namespace | Namespace | فضای نام گره Element فرزند |
برگشت
Element
- گره Element
، یا اگر هیچ گره Element
فرزند فوری با نام و فضای نام داده شده وجود نداشته باشد null
.
getChildText(name)
اگر گره فرزند مستقیم گره Element
باشد، مقدار متن گره را با نام داده شده و بدون فضای نام دریافت می کند. اگر چنین گره ای وجود نداشته باشد، این متد null
را برمی گرداند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
name | String | نام گره فرزند |
برگشت
String
- مقدار متن گره فرزند، یا اگر هیچ گره فرزند فوری با نام داده شده و فضای نام وجود نداشته باشد null
.
getChildText(name, namespace)
مقدار متن گره را با نام و فضای نام داده شده دریافت می کند، اگر گره فرزند مستقیم گره Element
باشد. اگر چنین گره ای وجود نداشته باشد، این متد null
را برمی گرداند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
name | String | نام گره فرزند |
namespace | Namespace | فضای نام گره فرزند |
برگشت
String
- مقدار متنی گره فرزند، یا اگر هیچ گره فرزند فوری با نام و فضای نام داده شده وجود نداشته باشد، null
.
getChildren()
تمام گره های Element
را که فرزندان مستقیم این گره Element
هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
برگشت
Element[]
- آرایهای از تمام گرههای Element
که فرزندان مستقیم این گره Element
هستند
getChildren(name)
تمام گره های Element
را با نام مشخص شده و بدون فضای نام که فرزندان مستقیم این گره Element
هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
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
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()
getNamespace(prefix)
فضای نام را با پیشوند داده شده برای گره Element
دریافت می کند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
prefix | String | پیشوند فضای نام |
برگشت
Namespace
- فضای نام با پیشوند داده شده برای گره Element
getParentElement()
getQualifiedName()
نام محلی و پیشوند فضای نام گره Element
را به شکل [namespacePrefix]:[localName]
دریافت میکند. اگر گره پیشوند فضای نام ندارد، از getName()
استفاده کنید.
برگشت
String
- نام محلی و پیشوند فضای نام گره Element
، به شکل [namespacePrefix]:[localName]
getText()
مقدار متن گره Element
را دریافت می کند.
برگشت
String
- مقدار متن گره Element
getValue()
مقدار متن تمام گره هایی را که فرزندان مستقیم یا غیرمستقیم گره هستند، به ترتیبی که در سند ظاهر می شوند، دریافت می کند.
برگشت
String
- مقدار متن تمام گره هایی که فرزندان مستقیم یا غیرمستقیم گره هستند
isAncestorOf(other)
تعیین می کند که آیا این گره Element
والد مستقیم یا غیرمستقیم یک گره Element
معین است.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
other | Element | گره Element دیگر |
برگشت
Boolean
- true
اگر این گره Element
والد مستقیم یا غیرمستقیم گره Element
داده شده باشد. false
اگر نه
isRootElement()
تعیین می کند که آیا گره Element
، گره اصلی سند است یا خیر.
برگشت
Boolean
- true
اگر گره Element
گره ریشه سند باشد. false
اگر نه
removeAttribute(attribute)
در صورت وجود چنین ویژگی، ویژگی داده شده را برای این گره Element
حذف می کند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
attribute | Attribute | ویژگی |
برگشت
Boolean
- true
اگر مشخصه وجود داشته باشد و حذف شود. false
اگر نه
removeAttribute(attributeName)
در صورت وجود چنین ویژگی، ویژگی این گره Element
را با نام داده شده و بدون فضای نام حذف می کند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
attributeName | String | نامی از مشخصات |
برگشت
Boolean
- true
اگر مشخصه وجود داشته باشد و حذف شود. false
اگر نه
removeAttribute(attributeName, namespace)
در صورت وجود چنین ویژگی، ویژگی این گره Element
را با نام و فضای نام داده شده حذف می کند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
attributeName | 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
setAttribute(attribute)
setAttribute(name, value)
ویژگی را برای این گره Element
با نام، مقدار و بدون فضای نام مشخص می کند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
name | String | نام ویژگی برای تنظیم |
value | String | مقدار صفت برای تنظیم |
برگشت
Element
- گره Element
، برای زنجیر
setAttribute(name, value, namespace)
setName(name)
نام محلی گره Element
را تنظیم می کند. برای تنظیم پیشوند فضای نام برای گره، از setNamespace(namespace)
در ارتباط با XmlService.getNamespace(prefix, uri)
استفاده کنید.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
name | String | نام محلی برای تنظیم |
برگشت
Element
- گره Element
، برای زنجیر
setNamespace(namespace)
setText(text)
مقدار متن گره Element
را تنظیم می کند. اگر گره قبلاً حاوی یک مقدار متن یا هر گره فرزند باشد، این روش محتوای قدیمی را بازنویسی می کند. برای افزودن یا درج محتوا به جای آن، از addContent(content)
یا addContent(index, content)
استفاده کنید.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
text | String | متن برای تنظیم |
برگشت
Element
- گره Element
، برای زنجیر