Class Element

Öğe

Bir XML Element düğümünün temsili. 

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

Yöntemler

YöntemDönüş türüKısa açıklama
addContent(content)ElementBelirtilen düğümü Element düğümünün son alt öğesi olarak ekler.
addContent(index, content)ElementBelirtilen düğümü, Element düğümünün en yakın alt öğeleri olan tüm düğümler arasında belirtilen dizine ekler.
cloneContent()Content[]{@code Element} düğümünün doğrudan alt öğeleri olan tüm düğümlerin bağlantısız kopyalarını oluşturur.
detach()Content|nullDüğümü üst Element düğümünden ayırır.
getAllContent()Content[]{@code Element} düğümünün doğrudan alt öğesi olan tüm düğümleri alır.
getAttribute(name)Attribute|nullBelirtilen ada sahip ve ad alanı içermeyen bu Element düğümünün özelliğini alır.
getAttribute(name, namespace)Attribute|nullBelirtilen ad ve ad alanına sahip bu Element düğümünün özelliğini alır.
getAttributes()Attribute[]Bu Element düğümünün tüm özelliklerini, dokümanda göründükleri sırayla alır.
getChild(name)Element|nullBelirtilen ada sahip ve ad alanı olmayan, bu Element düğümünün doğrudan alt öğesi olan ilk Element düğümünü alır.
getChild(name, namespace)Element|nullBelirtilen ada ve ad alanına sahip olan ve bu Element düğümünün doğrudan alt öğesi olan ilk Element düğümünü alır.
getChildText(name)String|nullDüğüm, Element düğümünün doğrudan alt öğesiyse belirtilen ada ve ad alanına sahip olmayan düğümün metin değerini alır.
getChildText(name, namespace)String|nullDüğüm, Element düğümünün doğrudan alt öğesiyse belirtilen ada ve ad alanına sahip düğümün metin değerini alır.
getChildren()Element[]Bu Element düğümünün doğrudan alt öğeleri olan tüm Element düğümlerini, dokümanda göründükleri sırayla alır.
getChildren(name)Element[]Belirli bir ada sahip olan ve ad alanı içermeyen, bu Element düğümünün doğrudan alt öğeleri olan tüm Element düğümlerini, dokümanda göründükleri sırayla alır.
getChildren(name, namespace)Element[]Belirli bir ada ve ad alanına sahip olan ve bu Element düğümünün doğrudan alt öğeleri olan tüm Element düğümlerini, belgede göründükleri sırayla alır.
getContent(index)Content|null{@code Element} düğümünün doğrudan alt öğeleri olan tüm düğümler arasında, belirtilen dizindeki düğümü alır.
getContentSize()Integer{@code Element} düğümünün doğrudan alt öğesi olan düğümlerin sayısını alır.
getDescendants()Content[]{@code Element} düğümünün doğrudan veya dolaylı alt öğesi olan tüm düğümleri, belgede göründükleri sırayla alır.
getDocument()Document{@code Element} düğümünü içeren XML dokümanını alır.
getName()StringElement düğümünün yerel adını alır.
getNamespace()NamespaceElement düğümünün ad alanını alır.
getNamespace(prefix)NamespaceElement düğümü için belirli bir ön ekle ad alanını alır.
getParentElement()Element|nullDüğümün üst Element düğümünü alır.
getQualifiedName()StringElement düğümünün yerel adını ve ad alanı önekini [namespacePrefix]:[localName] biçiminde alır.
getText()StringElement düğümünün metin değerini alır.
getValue()StringBelgede göründükleri sırayla, düğümün doğrudan veya dolaylı alt öğeleri olan tüm düğümlerin metin değerini alır.
isAncestorOf(other)BooleanBu Element düğümünün, belirli bir Element düğümünün doğrudan mı yoksa dolaylı olarak mı üst öğesi olduğunu belirler.
isRootElement()BooleanElement düğümünün dokümanın kök düğümü olup olmadığını belirler.
removeAttribute(attribute)BooleanBu Element düğümü için belirtilen özelliği (varsa) kaldırır.
removeAttribute(attributeName)BooleanBu Element düğümünün, belirtilen ada sahip ve ad alanı içermeyen özelliğini kaldırır (böyle bir özellik varsa).
removeAttribute(attributeName, namespace)BooleanBu Element düğümünün, belirtilen ada ve ad alanına sahip özelliğini (varsa) kaldırır.
removeContent()Content[]{@code Element} düğümünün doğrudan alt öğesi olan tüm düğümleri kaldırır.
removeContent(content)BooleanBelirtilen düğüm, {@code Element} düğümünün doğrudan alt öğesiyse kaldırır.
removeContent(index)Content|null{@code Element} düğümünün doğrudan alt öğeleri olan tüm düğümler arasında, belirtilen dizindeki düğümü kaldırır.
setAttribute(attribute)ElementBu Element düğümü için belirtilen özelliği ayarlar.
setAttribute(name, value)ElementBu Element düğümünün özelliğini, verilen ad ve değerle, ad alanı olmadan ayarlar.
setAttribute(name, value, namespace)ElementBu Element düğümünün özelliğini verilen ad, değer ve ad alanıyla ayarlar.
setName(name)ElementElement düğümünün yerel adını ayarlar.
setNamespace(namespace)ElementElement düğümünün ad alanını ayarlar.
setText(text)ElementElement düğümünün metin değerini ayarlar.

Ayrıntılı belgeler

addContent(content)

Belirtilen düğümü Element düğümünün son alt öğesi olarak ekler. content bağımsız değişkeni, Element nesnesi veya ContentType içinde listelenen bir türe karşılık gelen herhangi bir düğüm nesnesi olabilir.

Parametreler

AdTürAçıklama
contentContentEklenecek düğüm.

Return

Element: Zincirleme için Element düğümü.

addContent(index, content)

Belirtilen düğümü, Element düğümünün en yakın alt öğeleri olan tüm düğümler arasında belirtilen dizine ekler. content bağımsız değişkeni, Element nesnesi veya ContentType içinde listelenen bir türe karşılık gelen herhangi bir düğüm nesnesi olabilir.

Parametreler

AdTürAçıklama
indexIntegerDüğümün, Element düğümünün doğrudan alt öğeleri olan tüm düğümler arasına ekleneceği dizin.
contentContentEklenecek düğüm.

Return

Element: Zincirleme için Element düğümü.

cloneContent()

{@code Element} düğümünün doğrudan alt öğeleri olan tüm düğümlerin bağlantısız kopyalarını oluşturur.

Return

Content[]: {@code Element} düğümünün doğrudan alt öğeleri olan tüm düğümlerin bağlantısız kopyalarının dizisi.

detach()

Düğümü üst Element düğümünden ayırır. Düğümün üst öğesi yoksa bu yöntemin etkisi olmaz.

Return

Content|null: Ayrılmış düğüm.

getAllContent()

{@code Element} düğümünün doğrudan alt öğesi olan tüm düğümleri alır.

Return

Content[]: {@code Element} düğümünün en yakın alt öğeleri olan tüm düğümlerin dizisi.

getAttribute(name)

Belirtilen ada sahip ve ad alanı içermeyen bu Element düğümünün özelliğini alır. Böyle bir özellik yoksa bu yöntem null değerini döndürür.

Parametreler

AdTürAçıklama
nameStringÖzelliğin adı.

Return

Attribute|null: Özellik veya verilen ada sahip bir özellik ve ad alanı yoksa null.

getAttribute(name, namespace)

Belirtilen ad ve ad alanına sahip bu Element düğümünün özelliğini alır. Böyle bir düğüm yoksa bu yöntem null değerini döndürür.

Parametreler

AdTürAçıklama
nameStringÖzelliğin adı.
namespaceNamespaceÖzelliğin ad alanı.

Return

Attribute|null: Belirtilen ad ve ad alanına sahip bir özellik yoksa özellik veya null.

getAttributes()

Bu Element düğümünün tüm özelliklerini, dokümanda göründükleri sırayla alır.

Return

Attribute[]: Bu Element düğümünün tüm özelliklerinin dizisi.

getChild(name)

Belirtilen ada sahip ve ad alanı olmayan, bu Element düğümünün doğrudan alt öğesi olan ilk Element düğümünü alır. Böyle bir düğüm yoksa bu yöntem null değerini döndürür.

Parametreler

AdTürAçıklama
nameStringAlt Element düğümünün adı.

Return

Element|null: Element düğümü veya belirli bir ada sahip ve ad alanı olmayan hemen ilk alt Element düğümü yoksa null.

getChild(name, namespace)

Belirtilen ada ve ad alanına sahip olan ve bu Element düğümünün doğrudan alt öğesi olan ilk Element düğümünü alır. Böyle bir düğüm yoksa bu yöntem null değerini döndürür.

Parametreler

AdTürAçıklama
nameStringAlt Element düğümünün adı.
namespaceNamespaceAlt Element düğümünün ad alanı.

Return

Element|null: Element düğümü veya belirli bir ad ve ad alanına sahip hemen ilk alt Element düğümü yoksa null.

getChildText(name)

Düğüm, Element düğümünün doğrudan alt öğesiyse belirtilen ada ve ad alanına sahip olmayan düğümün metin değerini alır. Böyle bir düğüm yoksa bu yöntem null değerini döndürür.

Parametreler

AdTürAçıklama
nameStringAlt düğümün adı.

Return

String|null: Alt düğümün metin değeri veya verilen ada ve ad alanına sahip anında alt düğüm yoksa null.

getChildText(name, namespace)

Düğüm, Element düğümünün doğrudan alt öğesiyse belirtilen ada ve ad alanına sahip düğümün metin değerini alır. Böyle bir düğüm yoksa bu yöntem null değerini döndürür.

Parametreler

AdTürAçıklama
nameStringAlt düğümün adı.
namespaceNamespaceAlt düğümün ad alanı.

Return

String|null: Alt düğümün metin değeri veya belirtilen ad ve ad alanıyla doğrudan bir alt düğüm yoksa null.

getChildren()

Bu Element düğümünün doğrudan alt öğeleri olan tüm Element düğümlerini, dokümanda göründükleri sırayla alır.

Return

Element[]: Bu Element düğümünün doğrudan alt öğeleri olan tüm Element düğümlerinin dizisi.

getChildren(name)

Belirli bir ada sahip olan ve ad alanı içermeyen, bu Element düğümünün doğrudan alt öğeleri olan tüm Element düğümlerini, dokümanda göründükleri sırayla alır.

Parametreler

AdTürAçıklama
nameStringAlt Element düğümlerinin adı.

Return

Element[]: Belirli bir ada sahip olan ve ad alanı içermeyen tüm Element düğümlerinin dizisi. Bu düğümler, söz konusu Element düğümünün doğrudan alt öğeleridir.

getChildren(name, namespace)

Belirli bir ada ve ad alanına sahip olan ve bu Element düğümünün doğrudan alt öğeleri olan tüm Element düğümlerini, belgede göründükleri sırayla alır.

Parametreler

AdTürAçıklama
nameStringAlt Element düğümlerinin adı.
namespaceNamespaceAlt Element düğümlerinin ad alanı.

Return

Element[]: Belirli bir ada ve ad alanına sahip olan ve bu Element düğümünün doğrudan alt öğeleri olan tüm Element düğümlerinin dizisi.

getContent(index)

{@code Element} düğümünün doğrudan alt öğeleri olan tüm düğümler arasında, belirtilen dizindeki düğümü alır. Belirtilen dizinde düğüm yoksa bu yöntem null değerini döndürür.

Parametreler

AdTürAçıklama
indexInteger{@code Element} düğümünün en yakın alt öğeleri olan tüm düğümler arasındaki düğümün dizini.

Return

Content|null: Düğüm veya belirtilen dizinde düğüm yoksa null.

getContentSize()

{@code Element} düğümünün doğrudan alt öğesi olan düğümlerin sayısını alır.

Return

Integer: {@code Element} düğümünün doğrudan alt öğesi olan düğümlerin sayısı.

getDescendants()

{@code Element} düğümünün doğrudan veya dolaylı alt öğesi olan tüm düğümleri, belgede göründükleri sırayla alır.

Return

Content[]: {@code Element} düğümünün doğrudan veya dolaylı alt öğeleri olan tüm düğümlerin dizisi.

getDocument()

{@code Element} düğümünü içeren XML dokümanını alır.

Return

Document: {@code Element} düğümünü içeren belge.

getName()

Element düğümünün yerel adını alır. Düğümün ad alanı öneki varsa getQualifiedName() veya getNamespace() kullanın.getPrefix() ile öneki alın.

Return

String — Element düğümünün yerel adı.

getNamespace()

Element düğümünün ad alanını alır.

Return

Namespace: Element düğümünün ad alanı.

getNamespace(prefix)

Element düğümü için belirli bir ön ekle ad alanını alır.

Parametreler

AdTürAçıklama
prefixStringAd alanının ön eki.

Return

Namespace: Element düğümü için verilen ön eke sahip ad alanı.

getParentElement()

Düğümün üst Element düğümünü alır. Düğümün üst öğesi yoksa bu yöntem null değerini döndürür.

Return

Element|null: Üst Element düğümü.

getQualifiedName()

Element düğümünün yerel adını ve ad alanı önekini [namespacePrefix]:[localName] biçiminde alır. Düğümün ad alanı ön eki yoksa getName() kullanın.

Return

String: Element düğümünün yerel adı ve ad alanı ön eki, [namespacePrefix]:[localName] biçiminde.

getText()

Element düğümünün metin değerini alır.

Return

String: Element düğümünün metin değeri.

getValue()

Belgede göründükleri sırayla, düğümün doğrudan veya dolaylı alt öğeleri olan tüm düğümlerin metin değerini alır.

Return

String: Düğümün doğrudan veya dolaylı alt öğesi olan tüm düğümlerin metin değeri.

isAncestorOf(other)

Bu Element düğümünün, belirli bir Element düğümünün doğrudan mı yoksa dolaylı olarak mı üst öğesi olduğunu belirler.

Parametreler

AdTürAçıklama
otherElementDiğer Element düğümü.

Return

Boolean — Bu Element düğümü, belirtilen Element düğümünün doğrudan veya dolaylı üst öğesiyse true, değilse false.

isRootElement()

Element düğümünün dokümanın kök düğümü olup olmadığını belirler.

Return

Boolean — Element düğümü dokümanın kök düğümü ise true, değilse false.

removeAttribute(attribute)

Bu Element düğümü için belirtilen özelliği (varsa) kaldırır.

Parametreler

AdTürAçıklama
attributeAttributeÖzellik.

Return

Boolean: Özellik varsa ve kaldırıldıysa true, yoksa false.

removeAttribute(attributeName)

Bu Element düğümünün, belirtilen ada sahip ve ad alanı içermeyen özelliğini kaldırır (böyle bir özellik varsa).

Parametreler

AdTürAçıklama
attributeNameStringÖzelliğin adı.

Return

Boolean: Özellik varsa ve kaldırıldıysa true, yoksa false.

removeAttribute(attributeName, namespace)

Bu Element düğümünün, belirtilen ada ve ad alanına sahip özelliğini (varsa) kaldırır.

Parametreler

AdTürAçıklama
attributeNameStringÖzelliğin adı.
namespaceNamespaceÖzelliğin ad alanı.

Return

Boolean: Özellik varsa ve kaldırıldıysa true, yoksa false.

removeContent()

{@code Element} düğümünün doğrudan alt öğesi olan tüm düğümleri kaldırır.

Return

Content[] — Kaldırılmadan önce {@code Element} düğümünün doğrudan alt öğeleri olan tüm düğümlerin dizisi.

removeContent(content)

Belirtilen düğüm, {@code Element} düğümünün doğrudan alt öğesiyse kaldırır. content bağımsız değişkeni, Element nesnesi veya ContentType içinde listelenen bir türe karşılık gelen herhangi bir düğüm nesnesi olabilir.

Parametreler

AdTürAçıklama
contentContentKaldırılacak düğüm.

Return

Düğüm doğrudan alt öğe ise ve kaldırıldıysa Boolean — true, değilse false.

removeContent(index)

{@code Element} düğümünün doğrudan alt öğeleri olan tüm düğümler arasında, belirtilen dizindeki düğümü kaldırır. Belirtilen dizinde düğüm yoksa bu yöntem null değerini döndürür.

Parametreler

AdTürAçıklama
indexInteger{@code Element} düğümünün en yakın alt öğeleri olan tüm düğümler arasındaki düğümün dizini.

Return

Content|null — Kaldırılan düğüm veya belirtilen dizinde düğüm yoksa null.

setAttribute(attribute)

Bu Element düğümü için belirtilen özelliği ayarlar.

Parametreler

AdTürAçıklama
attributeAttributeAyarlanacak özellik.

Return

Element: Zincirleme için Element düğümü.

setAttribute(name, value)

Bu Element düğümünün özelliğini, verilen ad ve değerle, ad alanı olmadan ayarlar.

Parametreler

AdTürAçıklama
nameStringAyarlanacak özelliğin adı.
valueStringAyarlanacak özelliğin değeri.

Return

Element: Zincirleme için Element düğümü.

setAttribute(name, value, namespace)

Bu Element düğümünün özelliğini verilen ad, değer ve ad alanıyla ayarlar.

Parametreler

AdTürAçıklama
nameStringAyarlanacak özelliğin adı.
valueStringAyarlanacak özelliğin değeri.
namespaceNamespaceAyarlanacak özelliğin ad alanı.

Return

Element: Zincirleme için Element düğümü.

setName(name)

Element düğümünün yerel adını ayarlar. Düğüm için ad alanı ön eki ayarlamak üzere setNamespace(namespace) ile birlikte XmlService.getNamespace(prefix, uri) öğesini kullanın.

Parametreler

AdTürAçıklama
nameStringAyarlanacak yerel ad.

Return

Element: Zincirleme için Element düğümü.

setNamespace(namespace)

Element düğümünün ad alanını ayarlar.

Parametreler

AdTürAçıklama
namespaceNamespaceAyarlanacak ad alanı.

Return

Element: Zincirleme için Element düğümü.

setText(text)

Element düğümünün metin değerini ayarlar. Düğüm zaten bir metin değeri veya alt düğümler içeriyorsa bu yöntem eski içeriğin üzerine yazar. İçerik eklemek veya yerleştirmek için addContent(content) veya addContent(index, content) kullanın.

Parametreler

AdTürAçıklama
textStringAyarlanacak metin.

Return

Element: Zincirleme için Element düğümü.