Class Format

Format

Formatowanie służące do wyprowadzania dokumentu XML. Dostępne są 3 wstępnie zdefiniowane formaty, które można dodatkowo dostosować. 

// Log an XML document with specified formatting options.
const xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
const document = XmlService.parse(xml);
const output = XmlService.getCompactFormat()
                   .setLineSeparator('\n')
                   .setEncoding('UTF-8')
                   .setIndent('   ')
                   .format(document);
Logger.log(output);

Metody

MetodaZwracany typKrótki opis
format(document)StringWypisuje podany parametr Document jako sformatowany ciąg znaków.
format(element)StringWypisuje podany węzeł Element jako sformatowany ciąg znaków.
setEncoding(encoding)FormatOkreśla kodowanie znaków, którego ma używać formatowanie.
setIndent(indent)FormatUstawia ciąg znaków używany do wcięcia węzłów podrzędnych względem ich węzłów nadrzędnych.
setLineSeparator(separator)FormatUstawia ciąg znaków do wstawienia, gdy formatowanie normalnie wstawia podział wiersza.
setOmitDeclaration(omitDeclaration)FormatOkreśla, czy formatowanie powinno pomijać deklarację XML, np. <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)FormatOkreśla, czy formater powinien pominąć kodowanie w deklaracji XML, np. pole kodowania w <?xml version="1.0" encoding="UTF-8"?>.

Szczegółowa dokumentacja

format(document)

Wypisuje podany parametr Document jako sformatowany ciąg znaków.

Parametry

NazwaTypOpis
documentDocumentdokument do sformatowania

Powrót

String – sformatowany dokument

format(element)

Wypisuje podany węzeł Element jako sformatowany ciąg znaków.

Parametry

NazwaTypOpis
elementElementelement do sformatowania,

Powrót

String – sformatowany element

setEncoding(encoding)

Określa kodowanie znaków, którego ma używać formatowanie. Argument encoding musi być akceptowalnym kodowaniem XML, np. ISO-8859-1, US-ASCII, UTF-8 lub UTF-16. 

// Log an XML document with encoding that does not support certain special
// characters.
const xml = '<root><a><b>ಠ‿ಠ</b><b>ಠ‿ಠ</b></a></root>';
const document = XmlService.parse(xml);
const output =
    XmlService.getRawFormat().setEncoding('ISO-8859-1').format(document);
Logger.log(output);

Parametry

NazwaTypOpis
encodingStringkodowanie, którego chcesz użyć;

Powrót

Format – formatowanie, do łańcuchowania

setIndent(indent)

Ustawia ciąg znaków używany do wcięcia węzłów podrzędnych względem ich węzłów nadrzędnych. Ustawienie wcięcia innego niż null spowoduje wstawienie przez formatowanie znaku końca wiersza po każdym węźle. 

// Log an XML document with each child node indented four spaces.
const xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
const document = XmlService.parse(xml);
const output = XmlService.getCompactFormat().setIndent('    ').format(document);
Logger.log(output);

Parametry

NazwaTypOpis
indentStringwcięcie,

Powrót

Format – formatowanie, do łańcuchowania

setLineSeparator(separator)

Ustawia ciąg znaków do wstawienia, gdy formatowanie normalnie wstawia podział wiersza. Trzy wstępnie zdefiniowane formatowanie mają różne warunki wstawiania znaku końca wiersza. Domyślnym separatorem wiersza jest \r\n. 

// Log an XML document with several spaces and a pipe character in place of line
// breaks.
const xml = '<root><a><b>Text!</b><b>More text!</b></a></root>';
const document = XmlService.parse(xml);
const output =
    XmlService.getRawFormat().setLineSeparator(' | ').format(document);
Logger.log(output);

Parametry

NazwaTypOpis
separatorStringseparator do użycia

Powrót

Format – formatowanie, do łańcuchowania

setOmitDeclaration(omitDeclaration)

Określa, czy formatowanie powinno pomijać deklarację XML, np. <?xml version="1.0" encoding="UTF-8"?>.

Parametry

NazwaTypOpis
omitDeclarationBooleantrue, aby pominąć deklarację XML; false, aby ją uwzględnić.

Powrót

Format – formatowanie, do łańcuchowania

setOmitEncoding(omitEncoding)

Określa, czy formater powinien pominąć kodowanie w deklaracji XML, np. pole kodowania w <?xml version="1.0" encoding="UTF-8"?>.

Parametry

NazwaTypOpis
omitEncodingBooleantrue, aby pominąć kodowanie w deklaracji XML; false, aby je uwzględnić.

Powrót

Format – formatowanie, do łańcuchowania