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
Metoda | Zwracany typ | Krótki opis |
---|---|---|
add | Element | Dodaje podany węzeł jako ostatni element podrzędny węzła Element . |
add | Element | 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 . |
clone | Content[] | Tworzy niezałączone kopie wszystkich węzłów, które są bezpośrednimi podrzędnymi węzła {@code Element}. |
detach() | Content | Odłącza węzeł od nadrzędnego węzła Element . |
get | Content[] | Pobiera wszystkie węzły, które są bezpośrednimi podrzędnymi węzła {@code Element}. |
get | Attribute | Pobiera atrybut węzła Element o podanej nazwie bez podawania przestrzeni nazw. |
get | Attribute | Pobiera atrybut węzła Element o podanej nazwie i przestrzeni nazw. |
get | Attribute[] | Pobiera wszystkie atrybuty węzła Element w kolejności, w jakiej występują w dokumencie. |
get | Element | 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 . |
get | Element | 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 . |
get | String | 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 . |
get | String | 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 . |
get | 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. |
get | 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. |
get | 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. |
get | Content | 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}. |
get | Integer | Pobiera 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 podrzędnymi węzła {@code Element}, w kolejności, w jakiej występują w dokumencie. |
get | Document | Pobiera dokument XML zawierający węzeł {@code Element}. |
get | String | Pobiera lokalną nazwę węzła Element . |
get | Namespace | Pobiera nazwę przestrzeni nazw węzła Element . |
get | Namespace | Pobiera przestrzeń nazw z danym prefiksem dla węzła Element . |
get | Element | Pobiera węzeł nadrzędny Element węzła. |
get | String | Pobiera nazwę lokalną 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 podrzędnymi węzła, w kolejności, w jakiej występują w dokumencie. |
is | Boolean | Określa, czy ten węzeł Element jest węzłem nadrzędnym bezpośrednim czy pośrednim danego węzła Element . |
is | Boolean | Określa, czy węzeł Element jest węzłem głównym dokumentu. |
remove | Boolean | Usuwa dany atrybut z tego węzła Element , jeśli taki atrybut istnieje. |
remove | Boolean | Usuwa atrybut tego węzła Element o danej nazwie i bez przestrzeni nazw, jeśli taki atrybut istnieje. |
remove | Boolean | Usuwa atrybut tego węzła Element o danej nazwie i w danej przestrzeni nazw, jeśli taki atrybut istnieje. |
remove | Content[] | Usuwa wszystkie węzły, które są bezpośrednimi podrzędnymi węzła {@code Element}. |
remove | Boolean | Usuwa podany węzeł, jeśli jest on bezpośrednim podrzędnym węzła {@code Element}. |
remove | Content | 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}. |
set | Element | Ustawia podany atrybut dla tego węzła Element . |
set | Element | Ustawia atrybut tego węzła Element z podaną nazwą, wartością i bez przestrzeni nazw. |
set | Element | Ustawia atrybut tego węzła Element z podaną nazwą, 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)
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 Content
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
content | Content | węzeł do dołączenia. |
Powrót
Element
– węzeł Element
do łańcucha.
add Content(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 Content
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
index | Integer | indeks, 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 ; |
content | Content | węzeł do wstawienia |
Powrót
Element
– węzeł Element
do łańcucha.
clone Content()
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()
get All Content()
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}
get Attribute(name)
Pobiera atrybut węzła Element
o podanej nazwie bez podawania przestrzeni nazw. Jeśli nie ma takiego atrybutu, metoda zwraca null
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa atrybutu, |
Powrót
Attribute
– atrybut lub null
, jeśli nie ma atrybutu o podanej nazwie i nie ma żadnej przestrzeni nazw.
get Attribute(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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa atrybutu, |
namespace | Namespace | nazwa przestrzeni nazw atrybutu. |
Powrót
Attribute
– atrybut lub null
, jeśli nie ma atrybutu o podanej nazwie i w podanej przestrzeni nazw.
get Attributes()
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
.
get Child(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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa 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.
get Child(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
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
– węzeł Element
lub null
, jeśli nie ma węzła podrzędnego Element
o danej nazwie i przestrzeni nazw;
get Child Text(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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa 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.
get Child Text(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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa węzła podrzędnego. |
namespace | Namespace | przestrzeń 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
get Children()
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
.
get Children(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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa 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
.
get Children(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
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 danej nazwie i przestrzeni nazw, które są bezpośrednimi podrzędnymi węzła tego węzła Element
.
get Content(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
Nazwa | Typ | Opis |
---|---|---|
index | Integer | indeks 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.
get Content Size()
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}
get Descendants()
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}
get Document()
Pobiera 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 danym prefiksem dla węzła Element
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
prefix | String | prefiks przestrzeni nazw, |
Powrót
Namespace
– przestrzeń nazw z podanym prefiksem dla węzła Element
get Parent Element()
get Qualified Name()
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 get
.
Powrót
String
– lokalna nazwa i prefiks przestrzeni nazw węzła Element
w postaci [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 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
is Ancestor Of(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
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 nadrzędnym węzłem 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
w przeciwnym razie
remove Attribute(attribute)
Usuwa dany 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 danej 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 danej nazwie i w danej przestrzeni nazw, jeśli taki atrybut istnieje.
Parametry
Nazwa | Typ | Opis |
---|---|---|
attribute | String | nazwa atrybutu, |
namespace | Namespace | nazwa przestrzeni 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 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
remove Content(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 Content
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
content | Content | wę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
remove Content(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
Nazwa | Typ | Opis |
---|---|---|
index | Integer | indeks 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.
set Attribute(attribute)
set Attribute(name, value)
Ustawia atrybut tego węzła Element
z podaną nazwą, wartością i bez przestrzeni nazw.
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwę atrybutu do ustawienia. |
value | String | wartość atrybutu do ustawienia. |
Powrót
Element
– węzeł Element
do łańcucha.
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 | lokalna nazwa do ustawienia. |
Powrót
Element
– węzeł Element
do łańcucha.
set Namespace(namespace)
set Text(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 add
lub add
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | tekst do ustawienia |
Powrót
Element
– węzeł Element
do łańcucha.