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 | Dołącza podany 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
Element węzeł. |
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 podanej nazwie i 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 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 natychmiastowa
element podrzędny tego węzła Element . |
getChild(name, namespace) | Element | Pobiera pierwszy węzeł Element o podanej nazwie i przestrzeni nazw, która jest natychmiastowa
element podrzędny tego węzła Element . |
getChildText(name) | String | Pobiera wartość tekstową węzła o podanej nazwie i bez przestrzeni nazw, jeśli węzeł jest
bezpośredniego elementu podrzędnego węzła Element . |
getChildText(name, namespace) | String | Pobiera wartość tekstową węzła o podanej nazwie i przestrzeni nazw, jeśli węzeł jest bezpośrednim
elementu podrzędnego 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
w kolejności ich wyświetlania w dokumencie. |
getChildren(name) | Element[] | Pobiera wszystkie węzły (Element ) o podanej nazwie i nie ma przestrzeni nazw, które są bezpośrednimi elementami 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 elementami podrzędnymi instancji
w tym węźle Element w kolejności, w jakiej występują w dokumencie. |
getContent(index) | Content | Pobiera węzeł o danym indeksie wśród wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi Węzeł {@code Element}. |
getContentSize() | Integer | Pobiera liczbę węzłów, które są bezpośrednimi węzłami 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łami węzła {@code Element}, w kolejności widoczne 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 nazwę lokalną i prefiks przestrzeni nazw węzła Element w formacie [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 danego węzła, w kolejności w dokumencie. |
isAncestorOf(other) | Boolean | Określa, czy ten węzeł Element jest bezpośrednim czy pośrednim 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 dany 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 nie ma przestrzeni nazw, jeśli
taki atrybut istnieje. |
removeAttribute(attributeName, namespace) | Boolean | Usuwa atrybut tego węzła Element o danej nazwie i przestrzeni nazw, jeśli tak
atrybut istnieje. |
removeContent() | Content[] | Usuwa wszystkie węzły, które są bezpośrednimi węzłami 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 spośród wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi Węzeł {@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 o podanej nazwie, wartości i bez przestrzeni nazw. |
setAttribute(name, value, namespace) | Element | Ustawia atrybut tego węzła Element o podanej nazwie, 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)
Dołącza podany węzeł jako ostatni węzeł podrzędny węzła Element
. content
może być obiektem Element
lub dowolnym obiektem węzła odpowiadającym typowi
znajduje się w lokalizacji ContentType
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
content | Content | węzeł do dołączenia |
Powrót
Element
– węzeł Element
używany do tworzenia ł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
Element
węzeł. Argumentem content
może być obiekt Element
lub dowolny
obiekt węzła odpowiadający typowi wymienionemu w tabeli ContentType
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
index | Integer | indeks, w którym ma zostać wstawiony 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 |
Powrót
Element
– węzeł Element
używany do tworzenia ł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}.
Powrót
Content[]
– tablica niedołączonych kopii wszystkich węzłów, które są bezpośrednimi elementami podrzędnymi węzła
Węzeł {@code Element}
detach()
getAllContent()
Pobiera wszystkie węzły, które są bezpośrednimi węzłami 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 null
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa atrybutu |
Powrót
Attribute
– atrybut lub null
, jeśli nie ma atrybutu o danej nazwie i nie;
przestrzeń 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 |
Powrót
Attribute
– atrybut lub null
, jeśli nie ma atrybutu o danej nazwie i
przestrzeń 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 dla tego węzła Element
getChild(name)
Pobiera pierwszy węzeł Element
o podanej nazwie i nie ma przestrzeni nazw, która jest natychmiastowa
element podrzędny 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 |
Powrót
Element
– węzeł Element
lub null
, jeśli nie ma natychmiastowego węzła podrzędnego Element
o danej nazwie i przestrzeni nazw;
getChild(name, namespace)
Pobiera pierwszy węzeł Element
o podanej nazwie i przestrzeni nazw, która jest natychmiastowa
element podrzędny 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 |
Powrót
Element
– węzeł Element
lub null
, jeśli nie ma natychmiastowego węzła podrzędnego Element
o danej 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średniego elementu podrzędnego 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 |
Powrót
String
– wartość tekstowa węzła podrzędnego lub null
, jeśli nie ma bezpośredniego węzła podrzędnego;
z podaną nazwą 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
elementu podrzędnego 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 |
Powrót
String
– 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 węzłami podrzędnymi tego węzła Element
, w
w kolejności ich wyświetlania w dokumencie.
Powrót
Element[]
– tablica wszystkich Element
węzłów, 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 nie ma 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 Element węzła podrzędnego |
Powrót
Element[]
– tablica wszystkich Element
węzłów o podanej nazwie i bez przestrzeni nazw, które są
bezpośrednie elementy podrzędne 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 instancji
w tym węźle Element
w kolejności, w jakiej występują w dokumencie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa Element węzła podrzędnego |
namespace | Namespace | przestrzeń nazw Element węzłów podrzędnych |
Powrót
Element[]
– tablica wszystkich Element
węzłów o podanej nazwie i przestrzeni nazw, które są
bezpośrednie elementy podrzędne tego węzła Element
getContent(index)
Pobiera węzeł o danym indeksie wśród wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi
Węzeł {@code Element}. Jeśli pod danym indeksem nie ma węzła, ta 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 węzłami podrzędnymi węzła Węzeł {@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 węzłami 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łami węzła {@code Element}, w kolejności widoczne w dokumencie.
Powrót
Content[]
– tablica wszystkich węzłów, które są bezpośrednimi lub pośrednimi podrzędnymi węzłami 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()
do
pobierz prefiks.
Powrót
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 |
Powrót
Namespace
– przestrzeń nazw z podanym prefiksem węzła Element
,
getParentElement()
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
– nazwa lokalna 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 danego węzła, w kolejności w dokumencie.
Powrót
String
– wartość tekstowa wszystkich węzłów, które są bezpośrednimi lub pośrednimi podrzędnymi węzłami;
isAncestorOf(other)
Określa, czy ten węzeł Element
jest bezpośrednim czy pośrednim 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 nadrzędnym wobec danego
Element
węzeł; false
, jeśli nie
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 dany atrybut dla 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
removeAttribute(attributeName)
Usuwa atrybut tego węzła Element
o podanej nazwie i nie ma przestrzeni nazw, jeśli
taki atrybut istnieje.
Parametry
Nazwa | Typ | Opis |
---|---|---|
attributeName | String | nazwa 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 danej nazwie i przestrzeni nazw, jeśli został
atrybut istnieje.
Parametry
Nazwa | Typ | Opis |
---|---|---|
attributeName | String | nazwa atrybutu |
namespace | Namespace | przestrzeń 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 węzłami 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}, zanim zostały
zostały usunięte
removeContent(content)
Usuwa dany 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 odpowiadającym
typu wymienionego w tabeli ContentType
.
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
, jeśli nie
removeContent(index)
Usuwa węzeł w danym indeksie spośród wszystkich węzłów, które są bezpośrednimi węzłami podrzędnymi
Węzeł {@code Element}. Jeśli pod danym indeksem nie ma węzła, ta 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 węzłami podrzędnymi węzła Węzeł {@code Element} |
Powrót
Content
– węzeł, który został usunięty, lub null
, jeśli nie ma węzła w danym indeksie.
setAttribute(attribute)
setAttribute(name, value)
Ustawia atrybut tego węzła Element
o podanej nazwie, wartości i 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
używany do tworzenia łańcuchów;
setAttribute(name, value, namespace)
Ustawia atrybut tego węzła Element
o podanej nazwie, wartości i przestrzeni nazw.
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | nazwa atrybutu do ustawienia |
value | String | wartość atrybutu do ustawienia |
namespace | Namespace | przestrzeń nazw atrybutu do ustawienia |
Powrót
Element
– węzeł Element
używany do tworzenia łańcuchów;
setName(name)
Ustawia lokalną nazwę węzła Element
. Aby ustawić prefiks przestrzeni nazw węzła, użyj
setNamespace(namespace)
w połączeniu z XmlService.getNamespace(prefix, uri)
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | lokalną nazwę, którą chcesz ustawić |
Powrót
Element
– węzeł Element
używany do tworzenia łańcuchów;
setNamespace(namespace)
setText(text)
Ustawia wartość tekstową węzła Element
. Jeśli węzeł zawiera już wartość tekstową lub
wszystkich węzłów podrzędnych, ta metoda zastępuje starą zawartość. Aby zamiast tego 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 |
Powrót
Element
– węzeł Element
służący do tworzenia łańcuchów;