Class Element

Element

Reprezentacja węzła XMLElement.

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

Metody

MetodaZwracany typKrótki opis
addContent(content)ElementDołącza podany węzeł jako ostatni element podrzędny węzła Element.
addContent(index, content)ElementWstawia podany węzeł pod podanym indeksem wśród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła Element.
cloneContent()Content[]Tworzy nieprzyłączone kopie wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.
detach()Content|nullOdłącza węzeł od węzła nadrzędnego Element.
getAllContent()Content[]Pobiera wszystkie węzły, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.
getAttribute(name)Attribute|nullPobiera atrybut tego węzła Element o podanej nazwie i bez przestrzeni nazw.
getAttribute(name, namespace)Attribute|nullPobiera atrybut tego węzła Element o podanej nazwie i przestrzeni nazw.
getAttributes()Attribute[]Pobiera wszystkie atrybuty tego węzła Element w kolejności, w jakiej występują w dokumencie.
getChild(name)Element|nullPobiera pierwszy węzeł Element o podanej nazwie i bez przestrzeni nazw, który jest bezpośrednim węzłem podrzędnym węzła Element.
getChild(name, namespace)Element|nullPobiera pierwszy węzeł Element o podanej nazwie i przestrzeni nazw, który jest bezpośrednim elementem podrzędnym węzła Element.
getChildText(name)String|nullPobiera wartość tekstową węzła o podanej nazwie i bez przestrzeni nazw, jeśli węzeł jest bezpośrednim elementem podrzędnym węzła Element.
getChildText(name, namespace)String|nullPobiera wartość tekstową węzła o podanej 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 elementami 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 elementami podrzędnymi 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 elementami podrzędnymi tego węzła Element, w kolejności, w jakiej występują w dokumencie.
getContent(index)Content|nullZwraca węzeł o podanym indeksie spośród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.
getContentSize()IntegerZwraca 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 węzłami podrzędnymi węzła {@code Element}, w kolejności, w jakiej występują w dokumencie.
getDocument()DocumentZwraca 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 dla węzła Element.
getParentElement()Element|nullZwraca węzeł nadrzędny węzła Element.
getQualifiedName()StringPobiera lokalną nazwę i prefiks przestrzeni nazw węzła Element w formacie [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 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 z 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 podany węzeł, jeśli jest on bezpośrednim elementem podrzędnym węzła {@code Element}.
removeContent(index)Content|nullUsuwa węzeł o podanym indeksie spośród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.
setAttribute(attribute)ElementUstawia podany atrybut dla tego węzła Element.
setAttribute(name, value)ElementUstawia atrybut dla tego węzła Element o podanej nazwie i wartości bez przestrzeni nazw.
setAttribute(name, value, namespace)ElementUstawia atrybut tego węzła Element o podanej nazwie, wartości i przestrzeni nazw.
setName(name)ElementUstawia lokalną nazwę węzła Element.
setNamespace(namespace)ElementUstawia przestrzeń nazw dla węzła Element.
setText(text)ElementUstawia wartość tekstową węzła Element.

Szczegółowa dokumentacja

addContent(content)

Dołącza podany węzeł jako ostatni element podrzędny węzła Element. Argument content może być Element obiektem lub dowolnym obiektem węzła, który odpowiada typowi wymienionemu w ContentType.

Parametry

NazwaTypOpis
contentContentWęzeł do dołączenia.

Powrót

Element – węzeł Element do łączenia w łańcuch.


addContent(index, content)

Wstawia podany węzeł pod podanym indeksem wśród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła Element. Argument content może być obiektem Element lub dowolnym obiektem węzła, który odpowiada typowi wymienionemu w ContentType.

Parametry

NazwaTypOpis
indexIntegerIndeks, pod którym węzeł ma zostać wstawiony wśród wszystkich węzłów będących bezpośrednimi elementami podrzędnymi węzła Element.
contentContentWęzeł do wstawienia.

Powrót

Element – węzeł Element do łączenia w łańcuch.


cloneContent()

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

Powrót

Content[] – tablica nieprzyłą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 węzła nadrzędnego Element. Jeśli węzeł nie ma elementu nadrzędnego, ta metoda nie ma żadnego efektu.

Powrót

Content|null – odłączony węzeł.


getAllContent()

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

Powrót

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 podanej nazwie i bez przestrzeni nazw. Jeśli nie ma takiego atrybutu, ta metoda zwraca wartość null.

Parametry

NazwaTypOpis
nameStringNazwa atrybutu.

Powrót

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


getAttribute(name, namespace)

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

Parametry

NazwaTypOpis
nameStringNazwa atrybutu.
namespaceNamespacePrzestrzeń nazw atrybutu.

Powrót

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


getAttributes()

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

Powrót

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


getChild(name)

Pobiera pierwszy węzeł Element o podanej nazwie i bez przestrzeni nazw, który jest bezpośrednim węzłem podrzędnym węzła Element. Jeśli taki węzeł nie istnieje, ta metoda zwraca wartość null.

Parametry

NazwaTypOpis
nameStringNazwa węzła podrzędnego Element.

Powrót

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


getChild(name, namespace)

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

Parametry

NazwaTypOpis
nameStringNazwa węzła podrzędnego Element.
namespaceNamespacePrzestrzeń nazw węzła podrzędnego Element.

Powrót

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


getChildText(name)

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

Parametry

NazwaTypOpis
nameStringNazwa węzła podrzędnego.

Powrót

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


getChildText(name, namespace)

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

Parametry

NazwaTypOpis
nameStringNazwa węzła podrzędnego.
namespaceNamespacePrzestrzeń nazw węzła podrzędnego.

Powrót

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


getChildren()

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

Powrót

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 elementami podrzędnymi węzła Element, w kolejności, w jakiej występują w dokumencie.

Parametry

NazwaTypOpis
nameStringNazwa węzłów podrzędnych Element.

Powrót

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 elementami 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 węzłów podrzędnych Element.

Powrót

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


getContent(index)

Zwraca węzeł o podanym indeksie spośród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}. Jeśli pod danym indeksem nie ma węzła, ta metoda zwraca wartość null.

Parametry

NazwaTypOpis
indexIntegerIndeks węzła wśród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.

Powrót

Content|null – węzeł lub null, jeśli pod danym indeksem nie ma węzła.


getContentSize()

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

Powrót

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 węzłami podrzędnymi węzła {@code Element}, w kolejności, w jakiej występują w dokumencie.

Powrót

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


getDocument()

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

Powrót

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 uzyskać prefiks.

Powrót

String – lokalna nazwa węzła Element.


getNamespace()

Pobiera przestrzeń nazw węzła Element.

Powrót

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


getNamespace(prefix)

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

Parametry

NazwaTypOpis
prefixStringPrefiks przestrzeni nazw.

Powrót

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


getParentElement()

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

Powrót

Element|null – węzeł nadrzędny Element.


getQualifiedName()

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

Powrót

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


getText()

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

Powrót

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.

Powrót

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


isAncestorOf(other)

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

Parametry

NazwaTypOpis
otherElementDrugi węzeł Element.

Powrót

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


isRootElement()

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

Powrót

Boolean – true, jeśli węzeł Element jest węzłem głównym dokumentu; false, jeśli nie.


removeAttribute(attribute)

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

Parametry

NazwaTypOpis
attributeAttributeAtrybut.

Powrót

Boolean – true, jeśli atrybut istniał i został usunięty; false, jeśli nie.


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.

Powrót

Boolean – true, jeśli atrybut istniał i został usunięty; false, jeśli nie.


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.

Powrót

Boolean – true, jeśli atrybut istniał i został usunięty; false, jeśli nie.


removeContent()

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

Powrót

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


removeContent(content)

Usuwa podany węzeł, jeśli jest on bezpośrednim elementem podrzędnym węzła {@code Element}. Argument content może być obiektem Element lub dowolnym obiektem węzła, który odpowiada typowi wymienionemu w ContentType.

Parametry

NazwaTypOpis
contentContentWęzeł do usunięcia.

Powrót

Boolean – true jeśli węzeł był bezpośrednim elementem podrzędnym i został usunięty; false w przeciwnym razie.


removeContent(index)

Usuwa węzeł o podanym indeksie spośród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}. Jeśli pod danym indeksem nie ma węzła, ta metoda zwraca wartość null.

Parametry

NazwaTypOpis
indexIntegerIndeks węzła wśród wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}.

Powrót

Content|null – usunięty węzeł lub null, jeśli pod danym indeksem nie ma węzła.


setAttribute(attribute)

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

Parametry

NazwaTypOpis
attributeAttributeAtrybut do ustawienia.

Powrót

Element – węzeł Element do łączenia w łańcuch.


setAttribute(name, value)

Ustawia atrybut dla tego węzła Element o podanej nazwie i wartości bez przestrzeni nazw.

Parametry

NazwaTypOpis
nameStringNazwa atrybutu do ustawienia.
valueStringWartość atrybutu do ustawienia.

Powrót

Element – węzeł Element do łączenia w łańcuch.


setAttribute(name, value, namespace)

Ustawia atrybut tego węzła Element o podanej nazwie, wartości i przestrzeni nazw.

Parametry

NazwaTypOpis
nameStringNazwa atrybutu do ustawienia.
valueStringWartość atrybutu do ustawienia.
namespaceNamespacePrzestrzeń nazw atrybutu do ustawienia.

Powrót

Element – węzeł Element do łączenia w łańcuch.


setName(name)

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

Parametry

NazwaTypOpis
nameStringNazwa lokalna do ustawienia.

Powrót

Element – węzeł Element do łączenia w łańcuch.


setNamespace(namespace)

Ustawia przestrzeń nazw dla węzła Element.

Parametry

NazwaTypOpis
namespaceNamespacePrzestrzeń nazw do ustawienia.

Powrót

Element – węzeł Element do łączenia w łańcuch.


setText(text)

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

Parametry

NazwaTypOpis
textStringTekst do ustawienia.

Powrót

Element – węzeł Element do łączenia w łańcuch.