Class Element

Element

Reprezentacja węzła 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);

Metody

MetodaZwracany typKrótki opis
addContent(content)ElementDodaje dany węzeł jako ostatni węzeł podrzędny węzła Element.
addContent(index, content)ElementWstawia dany węzeł w danym indeksie wśród wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi węzła Element.
cloneContent()Content[]Tworzy niedołączone kopie wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.
detach()ContentOdłącza węzeł od jego nadrzędnego węzła Element.
getAllContent()Content[]Pobiera wszystkie węzły, które są bezpośrednimi węzłami podrzędnymi węzła {@code Element}.
getAttribute(name)AttributePobiera atrybut tego węzła Element o danej nazwie bez przestrzeni nazw.
getAttribute(name, namespace)AttributePobiera atrybut tego węzła Element o podanej nazwie i przestrzeni nazw.
getAttributes()Attribute[]Pobiera wszystkie atrybuty z tego węzła Element w kolejności, w jakiej występują w dokumencie.
getChild(name)ElementPobiera pierwszy węzeł Element o podanej nazwie i nie ma przestrzeni nazw, która jest bezpośrednim elementem podrzędnym tego węzła Element.
getChild(name, namespace)ElementPobiera pierwszy węzeł Element o podanej nazwie i przestrzeni nazw, który jest bezpośrednim elementem podrzędnym tego węzła Element.
getChildText(name)StringPobiera wartość tekstową węzła z podaną nazwą bez przestrzeni nazw, jeśli węzeł jest bezpośrednim elementem podrzędnym węzła Element.
getChildText(name, namespace)StringPobiera wartość tekstową węzła o danej nazwie i przestrzeni nazw, jeśli węzeł jest bezpośrednim elementem podrzędnym węzła Element.
getChildren()Element[]Pobiera wszystkie węzły Element, które są bezpośrednimi węzłami podrzędnymi tego węzła Element, w kolejności, w jakiej występują w dokumencie.
getChildren(name)Element[]Pobiera wszystkie węzły Element o podanej nazwie i bez przestrzeni nazw, które są bezpośrednimi węzłami podrzędnymi tego węzła Element, w kolejności, w jakiej występują w dokumencie.
getChildren(name, namespace)Element[]Pobiera wszystkie węzły Element o podanej nazwie i przestrzeni nazw, które są bezpośrednimi węzłami podrzędnymi tego węzła Element, w kolejności, w jakiej występują w dokumencie.
getContent(index)ContentPobiera węzeł o podanym indeksie ze wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi węzła {@code Element}.
getContentSize()IntegerPobiera liczbę węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.
getDescendants()Content[]Pobiera wszystkie węzły, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła {@code Element}, w kolejności, w jakiej występują w dokumencie.
getDocument()DocumentPobiera dokument XML zawierający węzeł {@code Element}.
getName()StringPobiera lokalną nazwę węzła Element.
getNamespace()NamespacePobiera przestrzeń nazw węzła Element.
getNamespace(prefix)NamespacePobiera przestrzeń nazw z podanym prefiksem węzła Element.
getParentElement()ElementPobiera nadrzędny węzeł Element węzła.
getQualifiedName()StringPobiera lokalną nazwę i prefiks przestrzeni nazw węzła Element w postaci [namespacePrefix]:[localName].
getText()StringPobiera wartość tekstową węzła Element.
getValue()StringPobiera wartość tekstową wszystkich węzłów, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła, w kolejności, w jakiej występują w dokumencie.
isAncestorOf(other)BooleanOkreśla, czy ten węzeł Element jest bezpośrednim czy pośrednim elementem nadrzędnym danego węzła Element.
isRootElement()BooleanOkreśla, czy węzeł Element jest węzłem głównym dokumentu.
removeAttribute(attribute)BooleanUsuwa podany atrybut dla tego węzła Element, jeśli taki atrybut istnieje.
removeAttribute(attributeName)BooleanUsuwa atrybut tego węzła Element o podanej nazwie i bez przestrzeni nazw, jeśli taki atrybut istnieje.
removeAttribute(attributeName, namespace)BooleanUsuwa atrybut tego węzła Element o podanej nazwie i przestrzeni nazw, jeśli taki atrybut istnieje.
removeContent()Content[]Usuwa wszystkie węzły, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.
removeContent(content)BooleanUsuwa dany węzeł, jeśli jest on bezpośrednim elementem podrzędnym węzła {@code Element}.
removeContent(index)ContentUsuwa węzeł w danym indeksie ze wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi węzła {@code Element}.
setAttribute(attribute)ElementUstawia podany atrybut dla tego węzła Element.
setAttribute(name, value)ElementUstawia atrybut tego węzła Element z podaną nazwą, wartością i bez przestrzeni nazw.
setAttribute(name, value, namespace)ElementUstawia atrybut tego węzła Element z podaną nazwą, wartością i przestrzenią nazw.
setName(name)ElementUstawia lokalną nazwę węzła Element.
setNamespace(namespace)ElementUstawia przestrzeń nazw węzła Element.
setText(text)ElementUstawia wartość tekstową węzła Element.

Szczegółowa dokumentacja

addContent(content)

Dodaje dany węzeł jako ostatni węzeł podrzędny węzła Element. Argumentem content może być obiekt Element lub dowolny obiekt węzła odpowiadający typowi wymienionemu w ContentType.

Parametry

NazwaTypOpis
contentContentwęzeł, który ma zostać dołączony

Powroty

Element – węzeł Element do łańcuchów


addContent(index, content)

Wstawia dany węzeł w danym indeksie wśród wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi węzła Element. Argumentem content może być obiekt Element lub dowolny obiekt węzła odpowiadający typowi wymienionemu w ContentType.

Parametry

NazwaTypOpis
indexIntegerindeks, w którym należy wstawić węzeł wśród wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi węzła Element
contentContentwęzeł do wstawienia

Powroty

Element – węzeł Element do łańcuchów


cloneContent()

Tworzy niedołączone kopie wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.

Powroty

Content[] – tablica niedołączonych kopii wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}


detach()

Odłącza węzeł od jego nadrzędnego węzła Element. Jeśli węzeł nie ma elementu nadrzędnego, ta metoda nie działa.

Powroty

Content – odłączony węzeł,


getAllContent()

Pobiera wszystkie węzły, które są bezpośrednimi węzłami podrzędnymi węzła {@code Element}.

Powroty

Content[] – tablica wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}


getAttribute(name)

Pobiera atrybut tego węzła Element o danej nazwie bez przestrzeni nazw. Jeśli nie ma takiego atrybutu, metoda zwraca null.

Parametry

NazwaTypOpis
nameStringnazwa atrybutu

Powroty

Attribute – atrybut lub null, jeśli nie ma atrybutu o podanej nazwie ani przestrzeni nazw.


getAttribute(name, namespace)

Pobiera atrybut tego węzła Element o podanej nazwie i przestrzeni nazw. Jeśli nie ma takiego węzła, ta metoda zwraca null.

Parametry

NazwaTypOpis
nameStringnazwa atrybutu
namespaceNamespaceprzestrzeń nazw atrybutu

Powroty

Attribute – atrybut lub null, jeśli nie ma atrybutu o danej nazwie i przestrzeni nazw.


getAttributes()

Pobiera wszystkie atrybuty z tego węzła Element w kolejności, w jakiej występują w dokumencie.

Powroty

Attribute[] – tablica wszystkich atrybutów tego węzła Element.


getChild(name)

Pobiera pierwszy węzeł Element o podanej nazwie i nie ma przestrzeni nazw, która jest bezpośrednim elementem podrzędnym tego węzła Element. Jeśli nie ma takiego węzła, ta metoda zwraca null.

Parametry

NazwaTypOpis
nameStringnazwa węzła podrzędnego Element

Powroty

Element – węzeł Element lub null, jeśli nie ma bezpośredniego węzła podrzędnego Element o danej nazwie ani przestrzeni nazw


getChild(name, namespace)

Pobiera pierwszy węzeł Element o podanej nazwie i przestrzeni nazw, który jest bezpośrednim elementem podrzędnym tego węzła Element. Jeśli nie ma takiego węzła, ta metoda zwraca null.

Parametry

NazwaTypOpis
nameStringnazwa węzła podrzędnego Element
namespaceNamespaceprzestrzeń nazw węzła podrzędnego Element

Powroty

Element – węzeł Element lub null, jeśli nie ma bezpośredniego węzła podrzędnego Element o danej nazwie i przestrzeni nazw


getChildText(name)

Pobiera wartość tekstową węzła z podaną nazwą bez przestrzeni nazw, jeśli węzeł jest bezpośrednim elementem podrzędnym węzła Element. Jeśli nie ma takiego węzła, ta metoda zwraca null.

Parametry

NazwaTypOpis
nameStringnazwa węzła podrzędnego

Powroty

String – wartość tekstowa węzła podrzędnego lub null, jeśli nie ma bezpośredniego węzła podrzędnego o podanej nazwie ani przestrzeni nazw.


getChildText(name, namespace)

Pobiera wartość tekstową węzła o danej nazwie i przestrzeni nazw, jeśli węzeł jest bezpośrednim elementem podrzędnym węzła Element. Jeśli nie ma takiego węzła, ta metoda zwraca null.

Parametry

NazwaTypOpis
nameStringnazwa węzła podrzędnego
namespaceNamespaceprzestrzeń nazw węzła podrzędnego

Powroty

String – wartość tekstowa węzła podrzędnego lub null, jeśli nie ma bezpośredniego węzła podrzędnego o danej nazwie i przestrzeni nazw.


getChildren()

Pobiera wszystkie węzły Element, które są bezpośrednimi węzłami podrzędnymi tego węzła Element, w kolejności, w jakiej występują w dokumencie.

Powroty

Element[] – tablica wszystkich węzłów Element, które są bezpośrednimi elementami podrzędnymi tego węzła Element


getChildren(name)

Pobiera wszystkie węzły Element o podanej nazwie i bez przestrzeni nazw, które są bezpośrednimi węzłami podrzędnymi tego węzła Element, w kolejności, w jakiej występują w dokumencie.

Parametry

NazwaTypOpis
nameStringnazwa węzłów podrzędnych Element

Powroty

Element[] – tablica wszystkich węzłów Element o podanej nazwie i bez przestrzeni nazw, które są bezpośrednimi elementami podrzędnymi tego węzła Element


getChildren(name, namespace)

Pobiera wszystkie węzły Element o podanej nazwie i przestrzeni nazw, które są bezpośrednimi węzłami podrzędnymi tego węzła Element, w kolejności, w jakiej występują w dokumencie.

Parametry

NazwaTypOpis
nameStringnazwa węzłów podrzędnych Element
namespaceNamespaceprzestrzeń nazw podrzędnych węzłów Element

Powroty

Element[] – tablica wszystkich węzłów Element o danej nazwie i przestrzeni nazw, które są bezpośrednimi elementami podrzędnymi tego węzła Element


getContent(index)

Pobiera węzeł o podanym indeksie ze wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi węzła {@code Element}. Jeśli o danym indeksie nie ma węzła, ta metoda zwraca null.

Parametry

NazwaTypOpis
indexIntegerindeks węzła we wszystkich węzłach, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}

Powroty

Content – węzeł lub null, jeśli nie ma węzła o danym indeksie;


getContentSize()

Pobiera liczbę węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.

Powroty

Integer – liczba węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}


getDescendants()

Pobiera wszystkie węzły, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła {@code Element}, w kolejności, w jakiej występują w dokumencie.

Powroty

Content[] – tablica wszystkich węzłów, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła {@code Element}


getDocument()

Pobiera dokument XML zawierający węzeł {@code Element}.

Powroty

Document – dokument zawierający węzeł {@code Element}.


getName()

Pobiera lokalną nazwę węzła Element. Jeśli węzeł ma prefiks przestrzeni nazw, użyj getQualifiedName() lub getNamespace().getPrefix(), aby pobrać prefiks.

Powroty

String – lokalna nazwa węzła Element,


getNamespace()

Pobiera przestrzeń nazw węzła Element.

Powroty

Namespace – przestrzeń nazw węzła Element.


getNamespace(prefix)

Pobiera przestrzeń nazw z podanym prefiksem węzła Element.

Parametry

NazwaTypOpis
prefixStringprefiks przestrzeni nazw

Powroty

Namespace – przestrzeń nazw z podanym prefiksem węzła Element


getParentElement()

Pobiera nadrzędny węzeł Element węzła. Jeśli węzeł nie ma elementu nadrzędnego, ta metoda zwraca null.

Powroty

Element – nadrzędny węzeł Element,


getQualifiedName()

Pobiera lokalną nazwę i prefiks przestrzeni nazw węzła Element w postaci [namespacePrefix]:[localName]. Jeśli węzeł nie ma prefiksu przestrzeni nazw, użyj getName().

Powroty

String – lokalna nazwa i prefiks przestrzeni nazw węzła Element w postaci [namespacePrefix]:[localName]


getText()

Pobiera wartość tekstową węzła Element.

Powroty

String – wartość tekstowa węzła Element.


getValue()

Pobiera wartość tekstową wszystkich węzłów, które są bezpośrednimi lub pośrednimi elementami podrzędnymi węzła, w kolejności, w jakiej występują w dokumencie.

Powroty

String – wartość tekstowa wszystkich węzłów, które są bezpośrednimi lub pośrednimi elementami podrzędnymi danego węzła.


isAncestorOf(other)

Określa, czy ten węzeł Element jest bezpośrednim czy pośrednim elementem nadrzędnym danego węzła Element.

Parametry

NazwaTypOpis
otherElementinny węzeł Element

Powroty

Booleantrue, jeśli ten węzeł Element jest bezpośrednim lub pośrednim elementem nadrzędnym danego węzła Element; w przeciwnym razie false


isRootElement()

Określa, czy węzeł Element jest węzłem głównym dokumentu.

Powroty

Booleantrue, jeśli węzeł Element jest węzłem głównym dokumentu; false, jeśli nie jest węzłem głównym


removeAttribute(attribute)

Usuwa podany atrybut dla tego węzła Element, jeśli taki atrybut istnieje.

Parametry

NazwaTypOpis
attributeAttributeatrybut

Powroty

Booleantrue, jeśli atrybut istniał i został usunięty; jeśli nie istnieje: false


removeAttribute(attributeName)

Usuwa atrybut tego węzła Element o podanej nazwie i bez przestrzeni nazw, jeśli taki atrybut istnieje.

Parametry

NazwaTypOpis
attributeNameStringnazwa atrybutu

Powroty

Booleantrue, jeśli atrybut istniał i został usunięty; jeśli nie istnieje: false


removeAttribute(attributeName, namespace)

Usuwa atrybut tego węzła Element o podanej nazwie i przestrzeni nazw, jeśli taki atrybut istnieje.

Parametry

NazwaTypOpis
attributeNameStringnazwa atrybutu
namespaceNamespaceprzestrzeń nazw atrybutu

Powroty

Booleantrue, jeśli atrybut istniał i został usunięty; jeśli nie istnieje: false


removeContent()

Usuwa wszystkie węzły, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.

Powroty

Content[] – tablica wszystkich węzłów, które były bezpośrednimi elementami podrzędnymi węzła {@code Element}, zanim zostały usunięte.


removeContent(content)

Usuwa dany węzeł, jeśli jest on bezpośrednim elementem podrzędnym węzła {@code Element}. Argumentem content może być obiekt Element lub dowolny obiekt węzła odpowiadający typowi wymienionemu w ContentType.

Parametry

NazwaTypOpis
contentContentwęzeł do usunięcia

Powroty

Booleantrue, jeśli węzeł był bezpośrednim węzłem podrzędnym i został usunięty; w przeciwnym razie false


removeContent(index)

Usuwa węzeł w danym indeksie ze wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi węzła {@code Element}. Jeśli o danym indeksie nie ma węzła, ta metoda zwraca null.

Parametry

NazwaTypOpis
indexIntegerindeks węzła we wszystkich węzłach, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}

Powroty

Content – węzeł, który został usunięty, lub null, jeśli nie ma węzła o danym indeksie.


setAttribute(attribute)

Ustawia podany atrybut dla tego węzła Element.

Parametry

NazwaTypOpis
attributeAttributeatrybut do ustawienia

Powroty

Element – węzeł Element do łańcuchów


setAttribute(name, value)

Ustawia atrybut tego węzła Element z podaną nazwą, wartością i bez przestrzeni nazw.

Parametry

NazwaTypOpis
nameStringnazwa atrybutu do ustawienia
valueStringwartość atrybutu do ustawienia

Powroty

Element – węzeł Element do łańcuchów


setAttribute(name, value, namespace)

Ustawia atrybut tego węzła Element z podaną nazwą, wartością i przestrzenią nazw.

Parametry

NazwaTypOpis
nameStringnazwa atrybutu do ustawienia
valueStringwartość atrybutu do ustawienia
namespaceNamespaceprzestrzeń nazw atrybutu do ustawienia

Powroty

Element – węzeł Element do łańcuchów


setName(name)

Ustawia lokalną nazwę węzła Element. Aby ustawić prefiks przestrzeni nazw dla węzła, użyj setNamespace(namespace) w połączeniu z XmlService.getNamespace(prefix, uri).

Parametry

NazwaTypOpis
nameStringnazwa lokalna do ustawienia

Powroty

Element – węzeł Element do łańcuchów


setNamespace(namespace)

Ustawia przestrzeń nazw węzła Element.

Parametry

NazwaTypOpis
namespaceNamespaceprzestrzeń nazw do ustawienia

Powroty

Element – węzeł Element do łańcuchów


setText(text)

Ustawia wartość tekstową węzła Element. Jeśli węzeł zawiera już wartość tekstową lub dowolne węzły podrzędne, ta metoda zastępuje starą zawartość. Aby dołączyć lub wstawić treść, użyj właściwości addContent(content) lub addContent(index, content).

Parametry

NazwaTypOpis
textStringtekst do ustawienia

Powroty

Element – węzeł Element do łańcuchów