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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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 สำหรับการทำสาย