헤더 섹션을 나타내는 요소입니다. Document
에는 일반적으로 최대 1개의 HeaderSection
가 포함됩니다. HeaderSection
에는 ListItem
, Paragraph
,
Table
요소. 문서 구조에 대한 자세한 내용은 Google Docs 확장 가이드를 참조하세요.
메서드
자세한 문서
appendHorizontalRule()
새 HorizontalRule
를 만들고 추가합니다.
HorizontalRule
가 새 Paragraph
에 포함됩니다.
리턴
HorizontalRule
- 새 가로 규칙입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
지정된 이미지 blob에서 새 InlineImage
를 만들고 추가합니다.
이미지가 새 Paragraph
에 포함됩니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
image | BlobSource | 이미지 데이터입니다. |
리턴
InlineImage
- 추가된 이미지입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
지정된 InlineImage
를 추가합니다.
InlineImage
가 새 Paragraph
에 포함됩니다.
기존 InlineImage
의 사본을 추가할 때 이 버전의 appendImage
를 사용합니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
image | InlineImage | 이미지 데이터입니다. |
리턴
InlineImage
- 추가된 이미지입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(listItem)
appendListItem(text)
appendParagraph(paragraph)
appendParagraph(text)
appendTable()
appendTable(cells)
지정된 각 문자열 값의 TableCell
가 포함된 새 Table
를 추가합니다.
이 방법은 또한 표 다음에 빈 단락을 추가합니다. Google Docs도구의 문서도 테이블로 끝날 수 없습니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
cells | String[][] | 새 표에 추가할 표 셀의 텍스트 콘텐츠입니다. |
리턴
Table
- 추가된 테이블입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(table)
지정된 Table
를 추가합니다.
기존 Table
의 사본을 추가할 때 이 버전의 appendTable
를 사용합니다.
이 방법은 또한 표 다음에 빈 단락을 추가합니다. 왜냐하면 Google Docs도구의 문서도
테이블로 끝날 수 없습니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
table | Table | 추가할 표입니다. |
리턴
Table
- 추가된 테이블입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
현재 요소의 분리된 전체 사본을 반환합니다.
요소에 있는 모든 하위 요소도 복사됩니다. 새 요소에는 있습니다.
리턴
HeaderSection
- 새 사본입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
수정을 위해 현재 요소의 Text
버전을 가져옵니다.
요소 콘텐츠를 서식 있는 텍스트로 조작하는 데 editAsText
를 사용합니다. editAsText
모드는 텍스트가 아닌 요소 (예: InlineImage
및 HorizontalRule
)를 무시합니다.
삭제된 텍스트 범위 내에 완전히 포함된 하위 요소는 요소에서 삭제됩니다.
var 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
: 현재 요소의 텍스트 버전
findElement(elementType)
요소의 콘텐츠에서 지정된 유형의 하위 요소를 검색합니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
elementType | ElementType | 검색할 요소의 유형입니다. |
리턴
RangeElement
- 검색 요소의 위치를 나타내는 검색 결과입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
요소의 콘텐츠를 검색하여 지정된 유형의 하위 요소를 찾습니다. 이때
RangeElement
로 지정되었습니다.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
매개변수
이름 | 유형 | 설명 |
---|---|---|
elementType | ElementType | 검색할 요소의 유형입니다. |
from | RangeElement | 검색할 검색 결과입니다. |
리턴
RangeElement
- 검색 요소의 다음 위치를 나타내는 검색 결과입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
정규 표현식을 사용하여 요소의 콘텐츠에서 지정된 텍스트 패턴을 검색합니다.
JavaScript 정규 표현식 기능의 하위 집합은 완전히 지원되지 않습니다. 예를 들면 다음과 같습니다. 그룹 및 모드 수정자를 캡처합니다.
제공된 정규 표현식 패턴이 각 텍스트 블록과 독립적으로 일치됩니다. .
매개변수
이름 | 유형 | 설명 |
---|---|---|
searchPattern | String | 검색할 패턴 |
리턴
RangeElement
— 검색 텍스트의 위치를 나타내는 검색 결과, 또는 없는 경우 null
일치
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
요소의 콘텐츠에서 지정된 텍스트 패턴(지정된 텍스트부터 시작)을 검색합니다. 표시됩니다.
JavaScript 정규 표현식 기능의 하위 집합은 완전히 지원되지 않습니다. 예를 들면 다음과 같습니다. 그룹 및 모드 수정자를 캡처합니다.
제공된 정규 표현식 패턴이 각 텍스트 블록과 독립적으로 일치됩니다. .
매개변수
이름 | 유형 | 설명 |
---|---|---|
searchPattern | String | 검색할 패턴 |
from | RangeElement | 검색할 검색결과 |
리턴
RangeElement
: 검색 텍스트의 다음 위치를 나타내는 검색 결과, 또는 없는 경우 null입니다.
일치
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
요소의 속성을 검색합니다.
결과는 유효한 각 요소 속성에 대한 속성을 포함하는 객체이며, 여기서 각 요소는
속성 이름은 DocumentApp.Attribute
열거형의 항목에 해당합니다.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
리턴
Object
- 요소의 속성입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
지정된 하위 색인에서 하위 요소를 검색합니다.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. var 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."); }
매개변수
이름 | 유형 | 설명 |
---|---|---|
childIndex | Integer | 검색할 하위 요소의 색인입니다. |
리턴
Element
- 지정된 색인의 하위 요소입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
getImages()
섹션에 포함된 모든 InlineImages
를 검색합니다.
리턴
InlineImage[]
- 섹션 이미지입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getListItems()
섹션에 포함된 모든 ListItems
를 검색합니다.
리턴
ListItem[]
- 섹션 목록 항목입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
하위 요소 수를 검색합니다.
var 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
getParagraphs()
섹션에 포함된 모든 Paragraphs
를 검색합니다 (ListItems
포함).
리턴
Paragraph[]
- 섹션 단락입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
요소의 상위 요소를 검색합니다.
상위 요소에 현재 요소가 포함되어 있습니다.
리턴
ContainerElement
- 상위 요소입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTables()
getText()
요소의 콘텐츠를 텍스트 문자열로 검색합니다.
리턴
String
: 텍스트 문자열로 표시된 요소의 콘텐츠
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
텍스트 정렬을 가져옵니다. 사용할 수 있는 정렬 유형은 DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
, DocumentApp.TextAlignment.SUPERSCRIPT
입니다.
리턴
TextAlignment
: 텍스트 정렬 유형 또는 null
(텍스트에 여러 유형의 텍스트가 포함된 경우)
텍스트 정렬이 설정되지 않은 경우
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
요소의 ElementType
를 검색합니다.
getType()
를 사용하여 지정된 요소의 정확한 유형을 확인합니다.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Obtain the first element in the active tab's body. var 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.'); }
리턴
ElementType
- 요소 유형입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
지정된 색인에 새 HorizontalRule
를 만들고 삽입합니다.
HorizontalRule
가 새 Paragraph
에 포함됩니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
childIndex | Integer | 요소를 삽입할 색인입니다. |
리턴
HorizontalRule
- 새 가로 규칙입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
지정된 이미지 blob에서 지정된 위치에 InlineImage
를 만들고 삽입합니다.
색인
매개변수
이름 | 유형 | 설명 |
---|---|---|
childIndex | Integer | 요소를 삽입할 색인입니다. |
image | BlobSource | 이미지 데이터입니다. |
리턴
InlineImage
- 삽입된 인라인 이미지입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
지정된 색인에 지정된 InlineImage
를 삽입합니다.
이미지가 새 Paragraph
에 포함됩니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
childIndex | Integer | 요소를 삽입할 색인입니다. |
image | InlineImage | 삽입할 이미지입니다. |
리턴
InlineImage
- 삽입된 인라인 이미지입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
insertListItem(childIndex, text)
insertParagraph(childIndex, paragraph)
insertParagraph(childIndex, text)
insertTable(childIndex)
insertTable(childIndex, cells)
insertTable(childIndex, table)
removeChild(child)
지정된 하위 요소를 삭제합니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
child | Element | 삭제할 하위 요소입니다. |
리턴
HeaderSection
- 현재 요소입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
상위 항목에서 요소를 삭제합니다.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab() var body = documentTab.getBody(); // Remove all images in the active tab's body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
리턴
HeaderSection
- 삭제된 요소입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
정규식을 사용하여 지정된 텍스트 패턴과 일치하는 모든 항목을 지정된 대체 문자열로 바꿉니다. 식을 사용할 수 있습니다.
검색 패턴은 JavaScript 정규 표현식 객체가 아닌 문자열로 전달됩니다. 따라서 패턴에서 백슬래시를 이스케이프 처리해야 합니다.
이 방법은 Google의 RE2 일반 표현식 라이브러리를 사용할 수 있습니다. 이 API는 지원되는 구문을 제한합니다.
제공된 정규 표현식 패턴이 각 텍스트 블록과 독립적으로 일치됩니다. .
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
매개변수
이름 | 유형 | 설명 |
---|---|---|
searchPattern | String | 검색할 정규식 패턴 |
replacement | String | 대체로 사용할 텍스트 |
리턴
Element
: 현재 요소
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
요소의 속성을 설정합니다.
지정된 속성 매개변수는 각 속성 이름이 항목인 객체여야 합니다.
DocumentApp.Attribute
열거형이며 각 속성 값은 새 값입니다.
적용됩니다.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Define a custom paragraph style. var 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. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
매개변수
이름 | 유형 | 설명 |
---|---|---|
attributes | Object | 요소의 속성입니다. |
리턴
HeaderSection
- 현재 요소입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
콘텐츠를 일반 텍스트로 설정합니다.
참고: 기존 콘텐츠는 삭제됩니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
text | String | 새 텍스트 콘텐츠입니다. |
리턴
HeaderSection
- 현재 요소입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
텍스트 정렬을 설정합니다. 사용할 수 있는 정렬 유형은 DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
, DocumentApp.TextAlignment.SUPERSCRIPT
입니다.
// Make the entire first paragraph in the active tab be superscript. var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); var text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
매개변수
이름 | 유형 | 설명 |
---|---|---|
textAlignment | TextAlignment | 적용할 텍스트 정렬 유형 |
리턴
HeaderSection
: 현재 요소
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents