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을 형식이 지정된 문자열로 출력합니다.

매개변수

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

Return

String: 서식이 지정된 문서

---

format(element)

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

매개변수

이름	유형	설명
element	Element	형식을 지정할 요소

Return

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

매개변수

이름	유형	설명
encoding	String	사용할 인코딩

Return

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

매개변수

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

Return

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

---

setLineSeparator(separator)

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

매개변수

이름	유형	설명
separator	String	구분 기호 사용

Return

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

---

setOmitDeclaration(omitDeclaration)

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

매개변수

이름	유형	설명
omitDeclaration	Boolean	XML 선언을 생략하려면 true, XML 선언을 포함하려면 false

Return

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

---

setOmitEncoding(omitEncoding)

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

매개변수

이름	유형	설명
omitEncoding	Boolean	true: XML 선언에서 인코딩을 생략하고 false는 인코딩을 제외합니다.

Return

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