바닥글 섹션을 나타내는 요소입니다. Document에는 일반적으로 Footer이 하나 이하로 포함됩니다. Footer에는 List, Paragraph, Table 요소가 포함될 수 있습니다. 문서 구조에 관한 자세한 내용은 Google Docs 확장 가이드를 참고하세요.
메서드
자세한 문서
append Horizontal Rule()
새 Horizontal를 만들어 추가합니다.
Horizontal는 새 Paragraph에 포함됩니다.
리턴
Horizontal - 새 가로줄입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Image(image)
지정된 이미지 blob에서 새 Inline를 만들어 추가합니다.
이미지는 새 Paragraph에 포함됩니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
image | Blob | 이미지 데이터입니다. |
리턴
Inline - 추가된 이미지입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Image(image)
지정된 Inline를 추가합니다.
Inline는 새 Paragraph에 포함됩니다.
기존 Inline의 사본을 추가할 때는 이 버전의 append를 사용하세요.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
image | Inline | 이미지 데이터입니다. |
리턴
Inline - 추가된 이미지입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append List Item(listItem)
append List Item(text)
append Paragraph(paragraph)
append Paragraph(text)
append Table()
append Table(cells)
지정된 각 문자열 값에 대한 Table이 포함된 새 Table을 추가합니다.
Google Docs 문서는 표로 끝날 수 없으므로 이 메서드는 표 뒤에 빈 단락도 추가합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
cells | String[][] | 새 테이블에 추가할 표 셀의 텍스트 콘텐츠입니다. |
리턴
Table - 추가된 테이블입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Table(table)
지정된 Table를 추가합니다.
기존 Table의 사본을 추가할 때는 이 버전의 append를 사용하세요.
Google Docs 문서는 표로 끝날 수 없으므로 이 메서드는 표 뒤에 빈 단락도 추가합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
table | Table | 추가할 테이블입니다. |
리턴
Table - 추가된 테이블입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
clear()
copy()
현재 요소의 분리된 전체 사본을 반환합니다.
요소에 있는 하위 요소도 복사됩니다. 새 요소에 상위 요소가 없습니다.
리턴
Footer - 새로운 문구입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
edit As Text()
수정을 위해 현재 요소의 Text 버전을 가져옵니다.
요소 콘텐츠를 서식 있는 텍스트로 조작하려면 edit를 사용하세요. edit 모드는 텍스트가 아닌 요소 (예: Inline 및 Horizontal)를 무시합니다.
삭제된 텍스트 범위 내에 완전히 포함된 하위 요소는 요소에서 삭제됩니다.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, 'An editAsText sample.'); body.insertHorizontalRule(0); body.insertParagraph(0, 'An example.'); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
리턴
Text: 현재 요소의 텍스트 버전
find Element(elementType)
요소의 콘텐츠에서 지정된 유형의 하위 요소를 검색합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
element | Element | 검색할 요소의 유형입니다. |
리턴
Range - 검색 요소의 위치를 나타내는 검색 결과입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Element(elementType, from)
지정된 Range에서 시작하여 지정된 유형의 하위 요소를 요소의 콘텐츠에서 검색합니다.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
element | Element | 검색할 요소의 유형입니다. |
from | Range | 검색할 검색 결과입니다. |
리턴
Range - 검색 요소의 다음 위치를 나타내는 검색 결과입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Text(searchPattern)
정규 표현식을 사용하여 요소의 콘텐츠에서 지정된 텍스트 패턴을 검색합니다.
캡처 그룹, 모드 수정자 등 JavaScript 정규 표현식 기능의 일부는 완전히 지원되지 않습니다.
제공된 정규 표현식 패턴은 현재 요소에 포함된 각 텍스트 블록에 대해 독립적으로 일치합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
search | String | 검색할 패턴 |
리턴
Range - 검색 텍스트의 위치를 나타내는 검색 결과 또는 일치하는 항목이 없는 경우 null
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Text(searchPattern, from)
지정된 검색 결과부터 시작하여 요소의 콘텐츠에서 지정된 텍스트 패턴을 검색합니다.
캡처 그룹, 모드 수정자 등 JavaScript 정규 표현식 기능의 일부는 완전히 지원되지 않습니다.
제공된 정규 표현식 패턴은 현재 요소에 포함된 각 텍스트 블록에 대해 독립적으로 일치합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
search | String | 검색할 패턴 |
from | Range | 검색할 검색 결과 |
리턴
Range - 검색 텍스트의 다음 위치를 나타내는 검색 결과입니다. 일치하는 항목이 없으면 null입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Attributes()
요소의 속성을 가져옵니다.
결과는 각 속성 이름이 Document 열거형의 항목에 해당하는 유효한 요소 속성의 속성을 포함하는 객체입니다.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
리턴
Object - 요소의 속성입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Child(childIndex)
지정된 하위 색인에 있는 하위 요소를 가져옵니다.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText('This is the first paragraph.'); }
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
child | Integer | 가져올 하위 요소의 색인입니다. |
리턴
Element - 지정된 색인의 하위 요소입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Child Index(child)
get Images()
섹션에 포함된 모든 Inline를 가져옵니다.
리턴
Inline - 섹션 이미지입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get List Items()
섹션에 포함된 모든 List를 가져옵니다.
리턴
List - 섹션 목록 항목입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Num Children()
자녀 수를 가져옵니다.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);
리턴
Integer - 자녀 수입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Paragraphs()
섹션에 포함된 모든 Paragraphs를 가져옵니다 (List 포함).
리턴
Paragraph[]|null - 섹션 단락입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Parent()
요소의 상위 요소를 가져옵니다.
상위 요소에 현재 요소가 포함되어 있습니다.
리턴
Container - 상위 요소입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Tables()
get Text()
요소의 콘텐츠를 텍스트 문자열로 가져옵니다.
리턴
String - 요소의 콘텐츠(텍스트 문자열)
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Text Alignment()
텍스트 정렬을 가져옵니다. 사용 가능한 정렬 유형은 Document, Document, Document입니다.
리턴
Text - 텍스트 정렬 유형 또는 텍스트에 여러 유형의 텍스트 정렬이 포함되어 있거나 텍스트 정렬이 설정된 적이 없는 경우 null
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Type()
요소의 Element를 가져옵니다.
get을 사용하여 지정된 요소의 정확한 유형을 확인합니다.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
리턴
Element: 요소 유형입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Horizontal Rule(childIndex)
지정된 색인에 새 Horizontal를 만들어 삽입합니다.
Horizontal는 새 Paragraph에 포함됩니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
child | Integer | 요소를 삽입할 색인입니다. |
리턴
Horizontal - 새 가로줄입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Image(childIndex, image)
지정된 이미지 blob에서 지정된 색인에 Inline을 만들어 삽입합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
child | Integer | 요소를 삽입할 색인입니다. |
image | Blob | 이미지 데이터입니다. |
리턴
Inline - 삽입된 인라인 이미지입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Image(childIndex, image)
지정된 색인에 지정된 Inline를 삽입합니다.
이미지는 새 Paragraph에 포함됩니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
child | Integer | 요소를 삽입할 색인입니다. |
image | Inline | 삽입할 이미지입니다. |
리턴
Inline - 삽입된 인라인 이미지입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert List Item(childIndex, listItem)
insert List Item(childIndex, text)
insert Paragraph(childIndex, paragraph)
insert Paragraph(childIndex, text)
insert Table(childIndex)
insert Table(childIndex, cells)
insert Table(childIndex, table)
remove Child(child)
지정된 하위 요소를 삭제합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
child | Element | 삭제할 하위 요소입니다. |
리턴
Footer - 현재 요소
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove From Parent()
요소를 상위 요소에서 삭제합니다.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
리턴
Footer - 삭제된 요소입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
replace Text(searchPattern, replacement)
정규 표현식을 사용하여 지정된 텍스트 패턴의 모든 항목을 지정된 대체 문자열로 바꿉니다.
검색 패턴은 JavaScript 정규 표현식 객체가 아닌 문자열로 전달됩니다. 따라서 패턴에서 백슬래시를 이스케이프해야 합니다.
이 메서드는 Google의 RE2 정규 표현식 라이브러리를 사용하므로 지원되는 문법이 제한됩니다.
제공된 정규 표현식 패턴은 현재 요소에 포함된 각 텍스트 블록에 대해 독립적으로 일치합니다.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
search | String | 검색할 정규식 패턴 |
replacement | String | 대체로 사용할 텍스트 |
리턴
Element - 현재 요소
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Attributes(attributes)
요소의 속성을 설정합니다.
지정된 속성 매개변수는 각 속성 이름이 Document 열거형의 항목이고 각 속성 값이 적용할 새 값인 객체여야 합니다.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
attributes | Object | 요소의 속성입니다. |
리턴
Footer - 현재 요소
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Text(text)
콘텐츠를 일반 텍스트로 설정합니다.
참고: 기존 콘텐츠는 삭제됩니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
text | String | 새 텍스트 콘텐츠입니다. |
리턴
Footer - 현재 요소
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Text Alignment(textAlignment)
텍스트 정렬을 설정합니다. 사용 가능한 정렬 유형은 Document, Document, Document입니다.
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
text | Text | 적용할 텍스트 정렬 유형 |
리턴
Footer - 현재 요소
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents