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

พารามิเตอร์

ชื่อTypeคำอธิบาย
contentContentโหนดที่จะต่อท้าย

รีเทิร์น

Element — โหนด Element สำหรับการทำเชน


addContent(index, content)

แทรกโหนดที่ให้ไว้ที่ดัชนีที่กำหนดระหว่างโหนดทั้งหมดที่เป็นโหนดย่อยที่อยู่ติดกันของโหนด Element อาร์กิวเมนต์ content อาจเป็นออบเจ็กต์ Element หรือออบเจ็กต์โหนดใดก็ได้ที่ตรงกับประเภทที่ระบุใน ContentType

พารามิเตอร์

ชื่อTypeคำอธิบาย
indexIntegerดัชนีที่จะแทรกโหนดระหว่างโหนดทั้งหมดที่เป็นระดับลูกของโหนด Element โดยตรง
contentContentโหนดที่จะแทรก

รีเทิร์น

Element — โหนด Element สำหรับการทำเชน


cloneContent()

สร้างสำเนาแบบไม่แนบของโหนดทั้งหมดที่เป็นระดับลูกของโหนด {@code Element}

รีเทิร์น

Content[] — อาร์เรย์ของสำเนาที่ไม่ได้แนบของโหนดทั้งหมดที่เป็นระดับลูกของโหนด {@code Element}


detach()

ปลดโหนดออกจากโหนด Element ระดับบนสุด หากโหนดไม่มีระดับบนสุด เมธอดนี้จะไม่มีผล

รีเทิร์น

Content — โหนดที่ปลดออก


getAllContent()

รับโหนดทั้งหมดที่เป็นระดับลูกของโหนด {@code Element}

รีเทิร์น

Content[] — อาร์เรย์ของโหนดทั้งหมดที่เป็นระดับลูกของโหนด {@code Element}


getAttribute(name)

รับแอตทริบิวต์สำหรับโหนด Element นี้ที่มีชื่อดังกล่าวและไม่มีเนมสเปซ หากไม่มีแอตทริบิวต์ดังกล่าว เมธอดนี้จะแสดง null

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อแอตทริบิวต์

รีเทิร์น

Attribute — แอตทริบิวต์ หรือ null หากไม่มีแอตทริบิวต์ที่มีชื่อนั้นๆ และไม่มีเนมสเปซ


getAttribute(name, namespace)

รับแอตทริบิวต์สำหรับโหนด Element นี้ที่มีชื่อและเนมสเปซที่ระบุ หากไม่มีโหนดดังกล่าว เมธอดนี้จะแสดง null

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อแอตทริบิวต์
namespaceNamespaceเนมสเปซของแอตทริบิวต์

รีเทิร์น

Attribute — แอตทริบิวต์ หรือ null หากไม่มีแอตทริบิวต์ที่มีชื่อและเนมสเปซที่ระบุ


getAttributes()

รับแอตทริบิวต์ทั้งหมดสำหรับโหนด Element นี้ตามลำดับที่ปรากฏในเอกสาร

รีเทิร์น

Attribute[] — อาร์เรย์ของแอตทริบิวต์ทั้งหมดสำหรับโหนด Element นี้


getChild(name)

รับโหนด Element รายการแรกที่มีชื่อดังกล่าวและไม่มีเนมสเปซที่เป็นระดับล่างของโหนด Element นี้ หากไม่มีโหนดดังกล่าว เมธอดนี้จะแสดงผล null

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อโหนดย่อย Element

รีเทิร์น

Element — โหนด Element หรือ null หากไม่มีโหนด Element ย่อยที่มีชื่อเดียวกันและไม่มีเนมสเปซทันที


getChild(name, namespace)

รับโหนด Element แรกที่มีชื่อและเนมสเปซที่ระบุซึ่งเป็นข้อมูลระดับล่างของโหนด Element นี้ หากไม่มีโหนดดังกล่าว เมธอดนี้จะแสดงผล null

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อโหนดย่อย Element
namespaceNamespaceเนมสเปซของโหนดย่อย Element

รีเทิร์น

Element — โหนด Element หรือ null หากไม่มีโหนด Element ย่อยที่มีชื่อและเนมสเปซที่ระบุ


getChildText(name)

รับค่าข้อความของโหนดที่มีชื่อตามและไม่มีเนมสเปซ หากโหนดเป็นระดับล่างของโหนด Element หากไม่มีโหนดดังกล่าว เมธอดนี้จะแสดง null

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อโหนดย่อย

รีเทิร์น

String — ค่าข้อความของโหนดย่อย หรือ null หากไม่มีโหนดย่อยชื่อนั้นโดยตรงและไม่มีเนมสเปซ


getChildText(name, namespace)

รับค่าข้อความของโหนดที่มีชื่อและเนมสเปซที่ระบุ หากโหนดเป็นโหนดระดับล่างสุดของโหนด Element หากไม่มีโหนดดังกล่าว เมธอดนี้จะแสดงผล null

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อโหนดย่อย
namespaceNamespaceเนมสเปซของโหนดย่อย

รีเทิร์น

String — ค่าข้อความของโหนดย่อย หรือ null หากไม่มีโหนดย่อยที่มีชื่อและเนมสเปซที่ระบุ


getChildren()

รับโหนด Element ทั้งหมดที่เป็นโหนดย่อยทันทีของโหนด Element นี้ตามลำดับที่ปรากฏในเอกสาร

รีเทิร์น

Element[] — อาร์เรย์ของโหนด Element ทั้งหมดที่เป็นระดับรองของโหนด Element นี้


getChildren(name)

รับโหนด Element ทั้งหมดที่มีชื่อที่ระบุและไม่มีเนมสเปซที่เป็นหน่วยย่อยที่อยู่ติดกันของโหนด Element นี้ตามลำดับที่ปรากฏในเอกสาร

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อของโหนดย่อย Element

รีเทิร์น

Element[] — อาร์เรย์ของ Element โหนดทั้งหมดที่มีชื่อนั้นๆ และไม่มีเนมสเปซที่เป็นระดับล่างของโหนด Element นี้


getChildren(name, namespace)

รับโหนด Element ทั้งหมดที่มีชื่อและเนมสเปซที่ระบุ ซึ่งเป็นโหนดย่อยที่อยู่ใต้โหนด Element นี้ตามลำดับที่ปรากฏในเอกสาร

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อของโหนดย่อย Element
namespaceNamespaceเนมสเปซของโหนดย่อย Element

รีเทิร์น

Element[] — อาร์เรย์ของโหนด Element ทั้งหมดที่มีชื่อและเนมสเปซที่ระบุ ซึ่งเป็นโหนดย่อยที่อยู่ติดกันของโหนด Element นี้


getContent(index)

รับโหนดที่ดัชนีที่กำหนดระหว่างโหนดทั้งหมดที่เป็นระดับลูกของโหนด {@code Element} หากไม่มีโหนดในดัชนีที่ระบุ เมธอดนี้จะแสดง null

พารามิเตอร์

ชื่อTypeคำอธิบาย
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

พารามิเตอร์

ชื่อTypeคำอธิบาย
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 ที่ระบุ

พารามิเตอร์

ชื่อTypeคำอธิบาย
otherElementโหนด Element อื่น

รีเทิร์น

Booleantrue หากโหนด Element นี้เป็นโหนดระดับบนสุดโดยตรงหรือโดยอ้อมของโหนด Element ที่ระบุ false หากไม่ใช่


isRootElement()

กำหนดว่าโหนด Element เป็นโหนดรากของเอกสารหรือไม่

รีเทิร์น

Booleantrue หากโหนด Element เป็นโหนดรูทของเอกสาร หรือ false หากไม่มี


removeAttribute(attribute)

นำแอตทริบิวต์ที่ระบุสำหรับโหนด Element นี้ออก หากมีแอตทริบิวต์ดังกล่าว

พารามิเตอร์

ชื่อTypeคำอธิบาย
attributeAttributeแอตทริบิวต์

รีเทิร์น

Booleantrue หากมีแอตทริบิวต์อยู่และถูกนำออก false หากไม่มีแอตทริบิวต์


removeAttribute(attributeName)

นำแอตทริบิวต์ของโหนด Element นี้ออกโดยใช้ชื่อตัวดังกล่าวและไม่มีเนมสเปซ หากมีแอตทริบิวต์ดังกล่าว

พารามิเตอร์

ชื่อTypeคำอธิบาย
attributeNameStringชื่อแอตทริบิวต์

รีเทิร์น

Booleantrue หากมีแอตทริบิวต์อยู่และถูกนำออก false หากไม่มีแอตทริบิวต์


removeAttribute(attributeName, namespace)

นำแอตทริบิวต์ของโหนด Element ที่มีชื่อและเนมสเปซที่ระบุออก หากมีแอตทริบิวต์ดังกล่าว

พารามิเตอร์

ชื่อTypeคำอธิบาย
attributeNameStringชื่อแอตทริบิวต์
namespaceNamespaceเนมสเปซของแอตทริบิวต์

รีเทิร์น

Booleantrue หากมีแอตทริบิวต์อยู่และถูกนำออก false หากไม่มีแอตทริบิวต์


removeContent()

นำโหนดทั้งหมดที่เป็นรายการย่อยทันทีของโหนด {@code Element}

รีเทิร์น

Content[] — อาร์เรย์ของโหนดทั้งหมดที่เป็นระดับลูกของโหนด {@code Element} ก่อนถูกนำออก


removeContent(content)

นำโหนดที่ระบุออก หากโหนดเป็นโหนดย่อยที่อยู่ติดกันของโหนด {@code Element} อาร์กิวเมนต์ content อาจเป็นออบเจ็กต์ Element หรือออบเจ็กต์โหนดใดก็ได้ที่ตรงกับประเภทที่ระบุใน ContentType

พารามิเตอร์

ชื่อTypeคำอธิบาย
contentContentโหนดที่จะนำออก

รีเทิร์น

Booleantrue หากโหนดเป็นโหนดย่อยที่เข้าถึงได้ทันทีและถูกนำออก false หากไม่มี


removeContent(index)

นำโหนดที่ดัชนีที่กำหนดออกจากโหนดทั้งหมดที่เป็นรายการย่อยทันทีของโหนด {@code Element} หากไม่มีโหนดในดัชนีที่ระบุ เมธอดนี้จะแสดง null

พารามิเตอร์

ชื่อTypeคำอธิบาย
indexIntegerดัชนีสำหรับโหนดในโหนดทั้งหมดที่เป็นระดับลูกของโหนด {@code Element}

รีเทิร์น

Content — โหนดที่ถูกนำออก หรือ null หากไม่มีโหนดในดัชนีที่ระบุ


setAttribute(attribute)

ตั้งค่าแอตทริบิวต์ที่ระบุสำหรับโหนด Element นี้

พารามิเตอร์

ชื่อTypeคำอธิบาย
attributeAttributeแอตทริบิวต์ที่จะตั้งค่า

รีเทิร์น

Element — โหนด Element สำหรับการทำเชน


setAttribute(name, value)

ตั้งค่าแอตทริบิวต์สำหรับโหนด Element นี้โดยใช้ชื่อ ค่า และไม่มีเนมสเปซ

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อแอตทริบิวต์ที่จะตั้ง
valueStringค่าของแอตทริบิวต์ที่จะตั้งค่า

รีเทิร์น

Element — โหนด Element สำหรับการทำเชน


setAttribute(name, value, namespace)

ตั้งค่าแอตทริบิวต์สำหรับโหนด Element นี้โดยใช้ชื่อ ค่า และเนมสเปซที่ระบุ

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อแอตทริบิวต์ที่จะตั้ง
valueStringค่าของแอตทริบิวต์ที่จะตั้งค่า
namespaceNamespaceเนมสเปซของแอตทริบิวต์ที่จะตั้งค่า

รีเทิร์น

Element — โหนด Element สำหรับการทำเชน


setName(name)

ตั้งชื่อในเครื่องของโหนด Element หากต้องการตั้งค่าคำนำหน้าเนมสเปซสำหรับโหนด ให้ใช้ setNamespace(namespace) ร่วมกับ XmlService.getNamespace(prefix, uri)

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อท้องถิ่นที่จะตั้ง

รีเทิร์น

Element — โหนด Element สำหรับการทำเชน


setNamespace(namespace)

ตั้งค่าเนมสเปซสำหรับโหนด Element

พารามิเตอร์

ชื่อTypeคำอธิบาย
namespaceNamespaceเนมสเปซที่จะตั้งค่า

รีเทิร์น

Element — โหนด Element สำหรับการทำเชน


setText(text)

ตั้งค่าข้อความของโหนด Element หากโหนดมีค่าข้อความหรือโหนดย่อยใดๆ อยู่แล้ว เมธอดนี้จะเขียนทับเนื้อหาเก่า หากต้องการเพิ่มหรือแทรกเนื้อหาแทน ให้ใช้ addContent(content) หรือ addContent(index, content)

พารามิเตอร์

ชื่อTypeคำอธิบาย
textStringข้อความที่จะตั้งค่า

รีเทิร์น

Element — โหนด Element สำหรับการทำเชน