Ta strona została przetłumaczona przez Cloud Translation API.

Class Format

Narzędzie do formatowania służące do generowania dokumentu XML z 3 wstępnie zdefiniowanymi formatami, niestandardowe.

// 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` w postaci sformatowanego ciągu znaków.
`format(element)`	`String`	Na wyjściu generuje dany węzeł `Element` w postaci sformatowanego ciągu znaków.
`setEncoding(encoding)`	`Format`	Określa kodowanie znaków, które powinno być używane przez narzędzie do formatowania.
`setIndent(indent)`	`Format`	Ustawia ciąg 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 ma być wstawiany za każdym razem, gdy narzędzie formatujące zwykle wstawia podział wiersza.
`setOmitDeclaration(omitDeclaration)`	`Format`	Określa, czy narzędzie formatujące ma pomijać deklarację XML, np. `<?xml version="1.0" encoding="UTF-8"?>`.
`setOmitEncoding(omitEncoding)`	`Format`	Określa, czy narzędzie formatujące ma pomijać kodowanie w deklaracji XML, takie jak polu kodowania w usłudze `<?xml version="1.0" encoding="UTF-8"?>`.

Szczegółowa dokumentacja

`format(document)`

Na wyjściu generuje podany Document w postaci sformatowanego ciągu znaków.

Parametry

Nazwa	Typ	Opis
`document`	`Document`	dokument do sformatowania

Powrót

String – sformatowany dokument

`format(element)`

Na wyjściu generuje dany węzeł Element w postaci sformatowanego ciągu znaków.

Parametry

Nazwa	Typ	Opis
`element`	`Element`	element do sformatowania

Powrót

String – element sformatowany;

`setEncoding(encoding)`

Określa kodowanie znaków, które powinno być używane przez narzędzie do formatowania. 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`	kodowanie, którego chcesz użyć

Powrót

Format – narzędzie do formatowania służące do tworzenia łańcuchów

`setIndent(indent)`

Ustawia ciąg używany do wcięcia węzłów podrzędnych względem ich elementów nadrzędnych. Ustawianie wcięcia w innym miejscu niż null spowoduje, że narzędzie formatujące 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`	należy użyć wcięcia.

Powrót

Format – narzędzie do formatowania służące do tworzenia łańcuchów

`setLineSeparator(separator)`

Ustawia ciąg znaków, który ma być wstawiany za każdym razem, gdy narzędzie formatujące zwykle wstawia podział wiersza. Trzy wstępnie zdefiniowane elementy formatujące 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.
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ć,

Powrót

Format – narzędzie do formatowania służące do tworzenia łańcuchów

`setOmitDeclaration(omitDeclaration)`

Określa, czy narzędzie formatujące 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 go uwzględnić

Powrót

Format – narzędzie do formatowania służące do tworzenia łańcuchów

`setOmitEncoding(omitEncoding)`

Określa, czy narzędzie formatujące ma pomijać kodowanie w deklaracji XML, takie jak polu kodowania w usłudze <?xml version="1.0" encoding="UTF-8"?>.

Parametry

Nazwa	Typ	Opis
`omitEncoding`	`Boolean`	`true`, aby pominąć kodowanie w deklaracji XML; `false` do uwzględnić

Powrót

Format – narzędzie do formatowania służące do tworzenia łańcuchów