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
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addContent(content) | Element | Dodaje dany węzeł jako ostatni węzeł podrzędny węzła Element . |
addContent(index, content) | Element | 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 . |
cloneContent() | Content[] | Tworzy niedołączone kopie wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła {@code Element}. |
detach() | Content | Odłą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) | Attribute | Pobiera atrybut tego węzła Element o danej nazwie bez przestrzeni nazw. |
getAttribute(name, namespace) | Attribute | Pobiera 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) | Element | 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 . |
getChild(name, namespace) | Element | Pobiera 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) | String | 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 . |
getChildText(name, namespace) | String | 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 . |
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) | Content | 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}. |
getContentSize() | Integer | Pobiera 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() | Document | Pobiera dokument XML zawierający węzeł {@code Element}. |
getName() | String | Pobiera lokalną nazwę węzła Element . |
getNamespace() | Namespace | Pobiera przestrzeń nazw węzła Element . |
getNamespace(prefix) | Namespace | Pobiera przestrzeń nazw z podanym prefiksem węzła Element . |
getParentElement() | Element | Pobiera nadrzędny węzeł Element węzła. |
getQualifiedName() | String | Pobiera lokalną nazwę i prefiks przestrzeni nazw węzła Element w postaci [namespacePrefix]:[localName] . |
getText() | String | Pobiera wartość tekstową węzła Element . |
getValue() | 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. |
isAncestorOf(other) | Boolean | Określa, czy ten węzeł Element jest bezpośrednim czy pośrednim elementem nadrzędnym danego węzła Element . |
isRootElement() | Boolean | Określa, czy węzeł Element jest węzłem głównym dokumentu. |
removeAttribute(attribute) | Boolean | Usuwa podany atrybut dla tego węzła Element , jeśli taki atrybut istnieje. |
removeAttribute(attributeName) | Boolean | Usuwa atrybut tego węzła Element o podanej nazwie i bez przestrzeni nazw, jeśli taki atrybut istnieje. |
removeAttribute(attributeName, namespace) | Boolean | Usuwa 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) | Boolean | Usuwa dany węzeł, jeśli jest on bezpośrednim elementem podrzędnym węzła {@code Element}. |
removeContent(index) | Content | 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}. |
setAttribute(attribute) | Element | Ustawia podany atrybut dla tego węzła Element . |
setAttribute(name, value) | Element | Ustawia atrybut tego węzła Element z podaną nazwą, wartością i bez przestrzeni nazw. |
setAttribute(name, value, namespace) | Element | Ustawia atrybut tego węzła Element z podaną nazwą, wartością i przestrzenią nazw. |
setName(name) | Element | Ustawia lokalną nazwę węzła Element . |
setNamespace(namespace) | Element | Ustawia przestrzeń nazw węzła Element . |
setText(text) | Element | Ustawia 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
Nazwa | Typ | Opis |
---|---|---|
content | Content | wę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
Nazwa | Typ | Opis |
---|---|---|
index | Integer | indeks, 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 |
content | Content | wę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()
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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa 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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa atrybutu |
namespace | Namespace | przestrzeń 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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa 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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa węzła podrzędnego Element |
namespace | Namespace | przestrzeń 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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa 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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa węzła podrzędnego |
namespace | Namespace | przestrzeń 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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa 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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa węzłów podrzędnych Element |
namespace | Namespace | przestrzeń 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
Nazwa | Typ | Opis |
---|---|---|
index | Integer | indeks 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()
getNamespace(prefix)
Pobiera przestrzeń nazw z podanym prefiksem węzła Element
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
prefix | String | prefiks przestrzeni nazw |
Powroty
Namespace
– przestrzeń nazw z podanym prefiksem węzła Element
getParentElement()
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
Nazwa | Typ | Opis |
---|---|---|
other | Element | inny węzeł Element |
Powroty
Boolean
– true
, 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
Boolean
– true
, 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
Nazwa | Typ | Opis |
---|---|---|
attribute | Attribute | atrybut |
Powroty
Boolean
– true
, 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
Nazwa | Typ | Opis |
---|---|---|
attributeName | String | nazwa atrybutu |
Powroty
Boolean
– true
, 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
Nazwa | Typ | Opis |
---|---|---|
attributeName | String | nazwa atrybutu |
namespace | Namespace | przestrzeń nazw atrybutu |
Powroty
Boolean
– true
, 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
Nazwa | Typ | Opis |
---|---|---|
content | Content | węzeł do usunięcia |
Powroty
Boolean
– true
, 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
Nazwa | Typ | Opis |
---|---|---|
index | Integer | indeks 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)
setAttribute(name, value)
Ustawia atrybut tego węzła Element
z podaną nazwą, wartością i bez przestrzeni nazw.
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa atrybutu do ustawienia |
value | String | wartość atrybutu do ustawienia |
Powroty
Element
– węzeł Element
do łańcuchów
setAttribute(name, value, namespace)
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
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa lokalna do ustawienia |
Powroty
Element
– węzeł Element
do łańcuchów
setNamespace(namespace)
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
Nazwa | Typ | Opis |
---|---|---|
text | String | tekst do ustawienia |
Powroty
Element
– węzeł Element
do łańcuchów