Class Element

องค์ประกอบ

การนําเสนอโหนด XML Element

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

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
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 สำหรับเชน