การแสดงโหนด 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
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
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)
getAttributes()
รับแอตทริบิวต์ทั้งหมดของโหนด Element
นี้ตามลำดับที่ปรากฏในเอกสาร
รีเทิร์น
Attribute[]
— อาร์เรย์ของแอตทริบิวต์ทั้งหมดสำหรับโหนด Element
นี้
getChild(name)
รับโหนด Element
แรกที่มีชื่อตามที่ระบุ และไม่มีเนมสเปซที่เป็นรายการโดยทันที
ย่อยของโหนด Element
นี้ หากไม่มีโหนดดังกล่าว เมธอดนี้จะแสดง null
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
name | String | ชื่อโหนดย่อย Element |
รีเทิร์น
Element
— โหนด Element
หรือ null
หากไม่มีโหนดย่อย Element
ที่อยู่ติดกันที่มีชื่อดังกล่าวและไม่มีเนมสเปซ
getChild(name, namespace)
รับโหนด Element
แรกที่มีชื่อและเนมสเปซที่ระบุทันที
ย่อยของโหนด Element
นี้ หากไม่มีโหนดดังกล่าว เมธอดนี้จะแสดง null
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
name | String | ชื่อโหนดย่อย Element |
namespace | Namespace | เนมสเปซของโหนดย่อย Element |
รีเทิร์น
Element
— โหนด Element
หรือ null
หากไม่มีโหนดย่อย Element
ที่อยู่ทันทีที่มีชื่อและเนมสเปซที่ระบุ
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()
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
สำหรับการทำสาย