Narzędzie do formatowania służące do generowania dokumentu XML z 3 wstępnie zdefiniowanymi formatami, które można dostosowywać.
// Log an XML document with specified formatting options. var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>'; var document = XmlService.parse(xml); var output = XmlService.getCompactFormat() .setLineSeparator('\n') .setEncoding('UTF-8') .setIndent(' ') .format(document); Logger.log(output);
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
format(document) | String | Na wyjściu generuje podany Document jako sformatowany ciąg znaków. |
format(element) | String | Na wyjściu generuje dany węzeł Element jako sformatowany ciąg znaków. |
setEncoding(encoding) | Format | Ustawia kodowanie znaków, których ma używać formater. |
setIndent(indent) | Format | Ustawia ciąg znaków używany do wcięcia węzłów podrzędnych względem ich elementów nadrzędnych. |
setLineSeparator(separator) | Format | Ustawia ciąg znaków, który będzie wstawiany za każdym razem, gdy narzędzie formatowania normalnie wstawia podział wiersza. |
setOmitDeclaration(omitDeclaration) | Format | Określa, czy narzędzie formatowania ma pomijać deklarację XML, np. <?xml version="1.0"
encoding="UTF-8"?> . |
setOmitEncoding(omitEncoding) | Format | Określa, czy narzędzie formatowania ma pomijać kodowanie w deklaracji XML, np. pole kodowania w <?xml version="1.0" encoding="UTF-8"?> . |
Szczegółowa dokumentacja
format(document)
format(element)
setEncoding(encoding)
Ustawia kodowanie znaków, których ma używać formater. Argument encoding
musi być akceptowanym kodowaniem XML, takim jak ISO-8859-1
, US-ASCII
, UTF-8
lub UTF-16
.
// Log an XML document with encoding that does not support certain special characters. var xml = '<root><a><b>ಠ‿ಠ</b><b>ಠ‿ಠ</b></a></root>'; var document = XmlService.parse(xml); var output = XmlService.getRawFormat() .setEncoding('ISO-8859-1') .format(document); Logger.log(output);
Parametry
Nazwa | Typ | Opis |
---|---|---|
encoding | String | kodowania, które należy zastosować |
Powroty
Format
– formater służący do tworzenia łańcuchów.
setIndent(indent)
Ustawia ciąg znaków używany do wcięcia węzłów podrzędnych względem ich elementów nadrzędnych. Ustawienie wcięcia innego niż null
spowoduje, że narzędzie formatowania wstawi podział wiersza po każdym węźle.
// Log an XML document with each child node indented four spaces. var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>'; var document = XmlService.parse(xml); var output = XmlService.getCompactFormat() .setIndent(' ') .format(document); Logger.log(output);
Parametry
Nazwa | Typ | Opis |
---|---|---|
indent | String | użyj wcięcia |
Powroty
Format
– formater służący do tworzenia łańcuchów.
setLineSeparator(separator)
Ustawia ciąg znaków, który będzie wstawiany za każdym razem, gdy narzędzie formatowania normalnie wstawia podział wiersza. Trzy wstępnie zdefiniowane programy formatujące mają różne warunki, w których wstawiają podział wiersza. Domyślny separator wierszy to \r\n
.
// Log an XML document with several spaces and a pipe character in place of line breaks. var xml = '<root><a><b>Text!</b><b>More text!</b></a></root>'; var document = XmlService.parse(xml); var output = XmlService.getRawFormat() .setLineSeparator(' | ') .format(document); Logger.log(output);
Parametry
Nazwa | Typ | Opis |
---|---|---|
separator | String | separatora, którego chcesz użyć |
Powroty
Format
– formater służący do tworzenia łańcuchów.
setOmitDeclaration(omitDeclaration)
Określa, czy narzędzie formatowania ma pomijać deklarację XML, np. <?xml version="1.0"
encoding="UTF-8"?>
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
omitDeclaration | Boolean | true , aby pominąć deklarację XML; false , aby ją uwzględnić |
Powroty
Format
– formater służący do tworzenia łańcuchów.
setOmitEncoding(omitEncoding)
Określa, czy narzędzie formatowania ma pomijać kodowanie w deklaracji XML, np. pole kodowania w <?xml version="1.0" encoding="UTF-8"?>
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
omitEncoding | Boolean | true – pominięcie kodowania w deklaracji XML; false – aby je uwzględnić |
Powroty
Format
– formater służący do tworzenia łańcuchów.