Class Element

Element

Węzeł 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);

Metody

MetodaZwracany typKrótki opis
addContent(content)ElementDodaje podany węzeł jako ostatni element podrzędny węzła Element.
addContent(index, content)ElementWstawia dany węzeł pod podanym indeksem wśród wszystkich węzłów, które są bezpośrednimi podrzędnymi węzła Element.
cloneContent()Content[]Tworzy niezałączone kopie wszystkich węzłów, które są bezpośrednimi podrzędnymi węzła {@code Element}.
detach()ContentOdłącza węzeł od nadrzędnego węzła Element.
getAllContent()Content[]Pobiera wszystkie węzły, które są bezpośrednimi podrzędnymi węzła {@code Element}.
getAttribute(name)AttributePobiera atrybut węzła Element o podanej nazwie bez podawania przestrzeni nazw.
getAttribute(name, namespace)AttributePobiera atrybut węzła Element o podanej nazwie i przestrzeni nazw.
getAttributes()Attribute[]Pobiera wszystkie atrybuty węzła Element w kolejności, w jakiej występują w dokumencie.
getChild(name)ElementPobiera pierwszy węzeł Element o podanej nazwie i bez przestrzeni nazw, który jest bezpośrednim podrzędnym węzłem tego węzła Element.
getChild(name, namespace)ElementPobiera pierwszy węzeł Element o podanej nazwie i przestrzeni nazw, który jest bezpośrednim podrzędnym węzłem tego węzła Element.
getChildText(name)StringPobiera wartość tekstową węzła o danej nazwie i bez przestrzeni nazw, jeśli węzeł jest węzłem bezpośrednim węzła Element.
getChildText(name, namespace)StringPobiera wartość tekstową węzła o podanej nazwie i przestrzeni nazw, jeśli węzeł jest bezpośrednim podrzędnym węzła Element.
getChildren()Element[]Pobiera wszystkie węzły Element, które są bezpośrednimi podrzędnymi 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 podrzędnymi węzła Element, w kolejności ich występowania w dokumencie.
getChildren(name, namespace)Element[]Pobiera wszystkie węzły Element o danej nazwie i w danej przestrzeni nazw, które są bezpośrednimi podrzędnymi węzła Element, w kolejności, w jakiej występują w dokumencie.
getContent(index)ContentPobiera węzeł o danym indeksie spośród wszystkich węzłów, które są bezpośrednimi 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 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 nazwę przestrzeni nazw węzła Element.
getNamespace(prefix)NamespacePobiera przestrzeń nazw z danym prefiksem dla węzła Element.
getParentElement()ElementPobiera węzeł nadrzędny Element węzła.
getQualifiedName()StringPobiera nazwę lokalną 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 podrzędnymi węzła, w kolejności, w jakiej występują w dokumencie.
isAncestorOf(other)BooleanOkreśla, czy ten węzeł Element jest węzłem nadrzędnym bezpośrednim czy pośrednim danego węzła Element.
isRootElement()BooleanOkreśla, czy węzeł Element jest węzłem głównym dokumentu.
removeAttribute(attribute)BooleanUsuwa dany atrybut z tego węzła Element, jeśli taki atrybut istnieje.
removeAttribute(attributeName)BooleanUsuwa atrybut tego węzła Element o danej nazwie i bez przestrzeni nazw, jeśli taki atrybut istnieje.
removeAttribute(attributeName, namespace)BooleanUsuwa atrybut tego węzła Element o danej nazwie i w danej przestrzeni nazw, jeśli taki atrybut istnieje.
removeContent()Content[]Usuwa wszystkie węzły, które są bezpośrednimi podrzędnymi węzła {@code Element}.
removeContent(content)BooleanUsuwa podany węzeł, jeśli jest on bezpośrednim podrzędnym węzła {@code Element}.
removeContent(index)ContentUsuwa węzeł o danym indeksie spośród wszystkich węzłów, które są bezpośrednimi 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 dla węzła Element.
setText(text)ElementUstawia wartość tekstową węzła Element.

Szczegółowa dokumentacja

addContent(content)

Dodaje podany węzeł jako ostatni element podrzędny 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
contentContentwęzeł do dołączenia.

Powrót

Element – węzeł Element do łańcucha.


addContent(index, content)

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

Parametry

NazwaTypOpis
indexIntegerindeks, w którym ma zostać wstawiony węzeł, spośród wszystkich węzłów będących bezpośrednimi podrzędnymi węzła Element;
contentContentwęzeł do wstawienia

Powrót

Element – węzeł Element do łańcucha.


cloneContent()

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

Powrót

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


detach()

Odłącza węzeł od nadrzędnego węzła Element. Jeśli węzeł nie ma elementu nadrzędnego, ta metoda nie ma żadnego wpływu.

Powrót

Content – odłączony węzeł


getAllContent()

Pobiera wszystkie węzły, które są bezpośrednimi 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 węzła Element o podanej nazwie bez podawania przestrzeni nazw. Jeśli nie ma takiego atrybutu, metoda zwraca null.

Parametry

NazwaTypOpis
nameStringnazwa atrybutu,

Powrót

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


getAttribute(name, namespace)

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

Parametry

NazwaTypOpis
nameStringnazwa atrybutu,
namespaceNamespacenazwa przestrzeni nazw atrybutu.

Powrót

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


getAttributes()

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

Powrót

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


getChild(name)

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

Parametry

NazwaTypOpis
nameStringnazwa węzła podrzędnego Element

Powrót

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


getChild(name, namespace)

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

Parametry

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

Powrót

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


getChildText(name)

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

Parametry

NazwaTypOpis
nameStringnazwa węzła podrzędnego.

Powrót

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


getChildText(name, namespace)

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

Parametry

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

Powrót

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


getChildren()

Pobiera wszystkie węzły Element, które są bezpośrednimi podrzędnymi 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 podrzędnymi węzła Element.


getChildren(name)

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

Parametry

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

Powrót

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


getChildren(name, namespace)

Pobiera wszystkie węzły Element o danej nazwie i w danej przestrzeni nazw, które są bezpośrednimi podrzędnymi 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 danej nazwie i przestrzeni nazw, które są bezpośrednimi podrzędnymi węzła tego węzła Element.


getContent(index)

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

Parametry

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

Powrót

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


getContentSize()

Pobiera 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 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()

Pobiera 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 nazwę przestrzeni nazw węzła Element.

Powrót

Namespace – przestrzeń nazw węzła Element


getNamespace(prefix)

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

Parametry

NazwaTypOpis
prefixStringprefiks przestrzeni nazw,

Powrót

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


getParentElement()

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

Powrót

Element – węzeł nadrzędny Element


getQualifiedName()

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

Powrót

String – lokalna nazwa i prefiks przestrzeni nazw węzła Element w postaci [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 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 podrzędnymi węzła


isAncestorOf(other)

Określa, czy ten węzeł Element jest węzłem nadrzędnym bezpośrednim czy pośrednim 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 nadrzędnym węzłem 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 w przeciwnym razie


removeAttribute(attribute)

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

Parametry

NazwaTypOpis
attributeAttributeatrybut

Powrót

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


removeAttribute(attributeName)

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

Parametry

NazwaTypOpis
attributeNameStringnazwa atrybutu,

Powrót

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


removeAttribute(attributeName, namespace)

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

Parametry

NazwaTypOpis
attributeNameStringnazwa atrybutu,
namespaceNamespacenazwa przestrzeni nazw atrybutu.

Powrót

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


removeContent()

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

Powrót

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


removeContent(content)

Usuwa podany węzeł, jeśli jest on bezpośrednim 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ł węzłem podrzędnym i został usunięty; false, jeśli nie


removeContent(index)

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

Parametry

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

Powrót

Content – węzeł, który został usunięty, lub null, jeśli w danym indeksie 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 łańcucha.


setAttribute(name, value)

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

Parametry

NazwaTypOpis
nameStringnazwę atrybutu do ustawienia.
valueStringwartość atrybutu do ustawienia.

Powrót

Element – węzeł Element do łańcucha.


setAttribute(name, value, namespace)

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

Parametry

NazwaTypOpis
nameStringnazwę atrybutu do ustawienia.
valueStringwartość atrybutu do ustawienia.
namespaceNamespaceprzestrzeń nazw atrybutu do ustawienia.

Powrót

Element – węzeł Element do łańcucha.


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
nameStringlokalna nazwa do ustawienia.

Powrót

Element – węzeł Element do łańcucha.


setNamespace(namespace)

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

Parametry

NazwaTypOpis
namespaceNamespaceprzestrzeń nazw do ustawienia.

Powrót

Element – węzeł Element do łańcucha.


setText(text)

Ustawia wartość tekstową węzła Element. Jeśli węzeł zawiera już wartość tekstową lub jakiekolwiek węzły podrzędne, ta metoda nadpisuje stare treści. Aby dołączyć lub wstawić treści, użyj polecenia addContent(content) lub addContent(index, content).

Parametry

NazwaTypOpis
textStringtekst do ustawienia

Powrót

Element – węzeł Element do łańcucha.