Class Format

Format

Formatowanie do generowania dokumentu XML z 3 wstępnie zdefiniowanymi formatami, 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)StringZwraca podany argument Document jako sformatowany ciąg tekstowy.
format(element)StringZwraca podany węzeł Element jako sformatowany ciąg znaków.
setEncoding(encoding)FormatOkreśla kodowanie znaków, którego ma używać moduł formatujący.
setIndent(indent)FormatUstawia ciąg znaków używany do wcięcia węzłów podrzędnych względem węzłów nadrzędnych.
setLineSeparator(separator)FormatUstawia ciąg znaków, który ma być wstawiany, gdy formatujący zwykle wstawia podział wiersza.
setOmitDeclaration(omitDeclaration)FormatOkreśla, czy formatujący ma pomijać deklarację XML, np. <?xml version="1.0" encoding="UTF-8"?>.
setOmitEncoding(omitEncoding)FormatOkreśla, czy formatujący ma pomijać kodowanie w deklaracji XML, np. pole kodowania w <?xml version="1.0" encoding="UTF-8"?>.

Szczegółowa dokumentacja

format(document)

Zwraca podany argument Document jako sformatowany ciąg tekstowy.

Parametry

NazwaTypOpis
documentDocumentDokument do sformatowania.

Powrót

String – sformatowany dokument.

format(element)

Zwraca 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ć moduł formatujący. Argument encoding musi być akceptowanym 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 – formatujący do łączenia.

setIndent(indent)

Ustawia ciąg znaków używany do wcięcia węzłów podrzędnych względem węzłów nadrzędnych. Ustawienie wcięcia innego niż null spowoduje, że formatujący będzie wstawiać znak podziału 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, którego chcesz użyć.

Powrót

Format – formatujący do łączenia.

setLineSeparator(separator)

Ustawia ciąg znaków, który ma być wstawiany, gdy formatujący zwykle wstawia podział wiersza. 3 wstępnie zdefiniowane formaty mają różne warunki wstawiania podziału wiersza. Domyślny separator wierszy to \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, którego chcesz użyć.

Powrót

Format – formatujący do łączenia.

setOmitDeclaration(omitDeclaration)

Określa, czy formatujący ma 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 – formatujący do łączenia.

setOmitEncoding(omitEncoding)

Określa, czy formatujący ma pomijać 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 – formatujący do łączenia.