Class Format

방식

추가로 맞춤설정할 수 있는 세 가지 사전 정의된 형식을 포함하는 XML 문서를 출력하기 위한 형식 지정 도구.

// 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);

방법

메서드반환 유형간략한 설명
format(document)String지정된 Document를 형식이 지정된 문자열로 출력합니다.
format(element)String지정된 Element 노드를 형식이 지정된 문자열로 출력합니다.
setEncoding(encoding)Format형식 지정 도구에서 사용해야 하는 문자 인코딩을 설정합니다.
setIndent(indent)Format상위 노드를 기준으로 하위 노드를 들여쓰기하는 데 사용되는 문자열을 설정합니다.
setLineSeparator(separator)Format형식 지정 도구에서 일반적으로 줄바꿈을 삽입할 때마다 삽입할 문자열을 설정합니다.
setOmitDeclaration(omitDeclaration)Format형식 지정 도구에서 XML 선언을 생략해야 하는지 여부를 설정합니다(예: <?xml version="1.0" encoding="UTF-8"?>).
setOmitEncoding(omitEncoding)Format형식 지정 도구에서 XML 선언에서 인코딩을 생략해야 하는지(예: <?xml version="1.0" encoding="UTF-8"?>의 인코딩 필드와) 설정합니다.

자세한 문서

format(document)

지정된 Document를 형식이 지정된 문자열로 출력합니다.

매개변수

이름유형설명
documentDocument서식을 지정할 문서

리턴

String: 서식이 지정된 문서


format(element)

지정된 Element 노드를 형식이 지정된 문자열로 출력합니다.

매개변수

이름유형설명
elementElement서식을 지정할 요소

리턴

String: 형식이 지정된 요소


setEncoding(encoding)

형식 지정 도구에서 사용해야 하는 문자 인코딩을 설정합니다. encoding 인수는 ISO-8859-1, US-ASCII, UTF-8, UTF-16와 같이 허용되는 XML 인코딩이어야 합니다.

// 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);

매개변수

이름유형설명
encodingString인코딩을 클릭하여

리턴

Format: 체이닝을 위한 형식 지정 도구


setIndent(indent)

상위 노드를 기준으로 하위 노드를 들여쓰기하는 데 사용되는 문자열을 설정합니다. null 이외의 들여쓰기를 설정하면 형식 지정 도구가 모든 노드 뒤에 줄바꿈을 삽입합니다.

// 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);

매개변수

이름유형설명
indentString사용할 들여쓰기

리턴

Format: 체이닝을 위한 형식 지정 도구


setLineSeparator(separator)

형식 지정 도구에서 일반적으로 줄바꿈을 삽입할 때마다 삽입할 문자열을 설정합니다. 사전 정의된 형식 지정 도구 3개는 줄바꿈을 삽입하는 조건이 서로 다릅니다. 기본 줄 구분 기호는 \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);

매개변수

이름유형설명
separatorString사용할 구분자

리턴

Format: 체이닝을 위한 형식 지정 도구


setOmitDeclaration(omitDeclaration)

형식 지정 도구에서 XML 선언을 생략해야 하는지 여부를 설정합니다(예: <?xml version="1.0" encoding="UTF-8"?>).

매개변수

이름유형설명
omitDeclarationBooleantrue: XML 선언을 생략하고 false: XML 선언을 포함합니다.

리턴

Format: 체이닝을 위한 형식 지정 도구


setOmitEncoding(omitEncoding)

형식 지정 도구에서 XML 선언에서 인코딩을 생략해야 하는지(예: <?xml version="1.0" encoding="UTF-8"?>의 인코딩 필드와) 설정합니다.

매개변수

이름유형설명
omitEncodingBooleanXML 선언에서 인코딩을 생략하려면 true, 인코딩을 포함하려면 false

리턴

Format: 체이닝을 위한 형식 지정 도구