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
| Metoda | Zwracany typ | Krótki opis |
|---|---|---|
add | Element | Dołącza podany węzeł jako ostatni element podrzędny węzła Element. |
add | Element | 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. |
clone | Content[] | Tworzy nieprzyłączone kopie wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}. |
detach() | Content|null | Odłącza węzeł od węzła nadrzędnego Element. |
get | Content[] | Pobiera wszystkie węzły, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}. |
get | Attribute|null | Pobiera atrybut tego węzła Element o podanej nazwie i bez przestrzeni nazw. |
get | Attribute|null | Pobiera atrybut tego węzła Element o podanej nazwie i przestrzeni nazw. |
get | Attribute[] | Pobiera wszystkie atrybuty tego węzła Element w kolejności, w jakiej występują w dokumencie. |
get | Element|null | 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. |
get | Element|null | Pobiera pierwszy węzeł Element o podanej nazwie i przestrzeni nazw, który jest bezpośrednim elementem podrzędnym węzła Element. |
get | String|null | 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. |
get | String|null | 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. |
get | 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. |
get | 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. |
get | 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. |
get | Content|null | 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}. |
get | Integer | Zwraca liczbę węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}. |
get | 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. |
get | Document | Zwraca dokument XML zawierający węzeł {@code Element}. |
get | String | Pobiera lokalną nazwę węzła Element. |
get | Namespace | Pobiera przestrzeń nazw węzła Element. |
get | Namespace | Pobiera przestrzeń nazw z podanym prefiksem dla węzła Element. |
get | Element|null | Zwraca węzeł nadrzędny węzła Element. |
get | String | Pobiera lokalną nazwę i prefiks przestrzeni nazw węzła Element w formacie [namespacePrefix]:[localName]. |
get | String | Pobiera wartość tekstową węzła Element. |
get | String | 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. |
is | Boolean | Określa, czy węzeł Element jest bezpośrednim czy pośrednim elementem nadrzędnym danego węzła Element. |
is | Boolean | Określa, czy węzeł Element jest węzłem głównym dokumentu. |
remove | Boolean | Usuwa podany atrybut z tego węzła Element, jeśli taki atrybut istnieje. |
remove | Boolean | Usuwa atrybut tego węzła Element o podanej nazwie i bez przestrzeni nazw, jeśli taki atrybut istnieje. |
remove | Boolean | Usuwa atrybut tego węzła Element o podanej nazwie i przestrzeni nazw, jeśli taki atrybut istnieje. |
remove | Content[] | Usuwa wszystkie węzły, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}. |
remove | Boolean | Usuwa podany węzeł, jeśli jest on bezpośrednim elementem podrzędnym węzła {@code Element}. |
remove | Content|null | 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}. |
set | Element | Ustawia podany atrybut dla tego węzła Element. |
set | Element | Ustawia atrybut dla tego węzła Element o podanej nazwie i wartości bez przestrzeni nazw. |
set | Element | Ustawia atrybut tego węzła Element o podanej nazwie, wartości i przestrzeni nazw. |
set | Element | Ustawia lokalną nazwę węzła Element. |
set | Element | Ustawia przestrzeń nazw dla węzła Element. |
set | Element | Ustawia wartość tekstową węzła Element. |
Szczegółowa dokumentacja
add Content(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 Content.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
content | Content | Węzeł do dołączenia. |
Powrót
Element – węzeł Element do łączenia w łańcuch.
add Content(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 Content.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
index | Integer | Indeks, 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. |
content | Content | Węzeł do wstawienia. |
Powrót
Element – węzeł Element do łączenia w łańcuch.
clone Content()
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()
get All Content()
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}.
get Attribute(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
| Nazwa | Typ | Opis |
|---|---|---|
name | String | Nazwa atrybutu. |
Powrót
Attribute|null – atrybut lub null, jeśli nie ma atrybutu o podanej nazwie i przestrzeni nazw.
get Attribute(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
| Nazwa | Typ | Opis |
|---|---|---|
name | String | Nazwa atrybutu. |
namespace | Namespace | Przestrzeń nazw atrybutu. |
Powrót
Attribute|null – atrybut lub null, jeśli nie ma atrybutu o podanej nazwie i przestrzeni nazw.
get Attributes()
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.
get Child(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
| Nazwa | Typ | Opis |
|---|---|---|
name | String | Nazwa 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.
get Child(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
| Nazwa | Typ | Opis |
|---|---|---|
name | String | Nazwa węzła podrzędnego Element. |
namespace | Namespace | Przestrzeń 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.
get Child Text(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
| Nazwa | Typ | Opis |
|---|---|---|
name | String | Nazwa 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.
get Child Text(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
| Nazwa | Typ | Opis |
|---|---|---|
name | String | Nazwa węzła podrzędnego. |
namespace | Namespace | Przestrzeń 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.
get Children()
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.
get Children(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
| Nazwa | Typ | Opis |
|---|---|---|
name | String | Nazwa 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.
get Children(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
| Nazwa | Typ | Opis |
|---|---|---|
name | String | Nazwa węzłów podrzędnych Element. |
namespace | Namespace | Przestrzeń 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.
get Content(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
| Nazwa | Typ | Opis |
|---|---|---|
index | Integer | Indeks 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.
get Content Size()
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}.
get Descendants()
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}.
get Document()
Zwraca dokument XML zawierający węzeł {@code Element}.
Powrót
Document – dokument zawierający węzeł {@code Element}.
get Name()
Pobiera lokalną nazwę węzła Element. Jeśli węzeł ma prefiks przestrzeni nazw, użyj get lub get.get, aby uzyskać prefiks.
Powrót
String – lokalna nazwa węzła Element.
get Namespace()
get Namespace(prefix)
Pobiera przestrzeń nazw z podanym prefiksem dla węzła Element.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
prefix | String | Prefiks przestrzeni nazw. |
Powrót
Namespace – przestrzeń nazw z danym prefiksem dla węzła Element.
get Parent Element()
get Qualified Name()
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 get.
Powrót
String – lokalna nazwa i prefiks przestrzeni nazw węzła Element w formacie [namespacePrefix]:[localName].
get Text()
Pobiera wartość tekstową węzła Element.
Powrót
String – wartość tekstowa węzła Element.
get Value()
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.
is Ancestor Of(other)
Określa, czy węzeł Element jest bezpośrednim czy pośrednim elementem nadrzędnym danego węzła Element.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
other | Element | Drugi 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.
is Root Element()
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.
remove Attribute(attribute)
Usuwa podany atrybut z tego węzła Element, jeśli taki atrybut istnieje.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
attribute | Attribute | Atrybut. |
Powrót
Boolean – true, jeśli atrybut istniał i został usunięty; false, jeśli nie.
remove Attribute(attributeName)
Usuwa atrybut tego węzła Element o podanej nazwie i bez przestrzeni nazw, jeśli taki atrybut istnieje.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
attribute | String | Nazwa atrybutu. |
Powrót
Boolean – true, jeśli atrybut istniał i został usunięty; false, jeśli nie.
remove Attribute(attributeName, namespace)
Usuwa atrybut tego węzła Element o podanej nazwie i przestrzeni nazw, jeśli taki atrybut istnieje.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
attribute | String | Nazwa atrybutu. |
namespace | Namespace | Przestrzeń nazw atrybutu. |
Powrót
Boolean – true, jeśli atrybut istniał i został usunięty; false, jeśli nie.
remove Content()
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.
remove Content(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 Content.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
content | Content | Wę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.
remove Content(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
| Nazwa | Typ | Opis |
|---|---|---|
index | Integer | Indeks 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.
set Attribute(attribute)
set Attribute(name, value)
Ustawia atrybut dla tego węzła Element o podanej nazwie i wartości bez przestrzeni nazw.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
name | String | Nazwa atrybutu do ustawienia. |
value | String | Wartość atrybutu do ustawienia. |
Powrót
Element – węzeł Element do łączenia w łańcuch.
set Attribute(name, value, namespace)
set Name(name)
Ustawia lokalną nazwę węzła Element. Aby ustawić prefiks przestrzeni nazw dla węzła, użyj elementu set w połączeniu z elementem Xml.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
name | String | Nazwa lokalna do ustawienia. |
Powrót
Element – węzeł Element do łączenia w łańcuch.
set Namespace(namespace)
set Text(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 add lub add.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
text | String | Tekst do ustawienia. |
Powrót
Element – węzeł Element do łączenia w łańcuch.