다른 요소를 포함할 수 있는 일반적인 요소입니다. 하위 요소를 포함할 수 있는 모든 요소(예: Paragraph
)는 ContainerElement
에서 상속됩니다.
메서드
자세한 문서
asBody()
asEquation()
asFootnoteSection()
현재 요소를 FootnoteSection
으로 반환합니다.
이 요소는 특정 요소가 특정 유형이라고 알려진 경우 자동 완성을 돕는 데 사용됩니다.
Return
FootnoteSection
: 현재 요소입니다.
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asHeaderSection()
현재 요소를 HeaderSection
으로 반환합니다.
이 요소는 특정 요소가 특정 유형이라고 알려진 경우 자동 완성을 돕는 데 사용됩니다.
Return
HeaderSection
: 현재 요소입니다.
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asListItem()
asParagraph()
asTable()
asTableCell()
asTableOfContents()
현재 요소를 TableOfContents
으로 반환합니다.
이 요소는 특정 요소가 특정 유형이라고 알려진 경우 자동 완성을 돕는 데 사용됩니다.
Return
TableOfContents
: 현재 요소입니다.
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asTableRow()
clear()
copy()
현재 요소의 분리된 딥 카피를 반환합니다.
요소에 있는 하위 요소도 모두 복사됩니다. 새 요소에는 상위 요소가 없습니다.
Return
ContainerElement
: 새 사본입니다.
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
수정할 현재 요소의 Text
버전을 가져옵니다.
요소 콘텐츠를 리치 텍스트로 조작하려면 editAsText
를 사용합니다. editAsText
모드는 텍스트가 아닌 요소 (예: InlineImage
및 HorizontalRule
)를 무시합니다.
삭제된 텍스트 범위 내에 완전히 포함된 하위 요소가 요소에서 삭제됩니다.
var body = DocumentApp.getActiveDocument().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);
Return
Text
: 현재 요소의 텍스트 버전
findElement(elementType)
요소의 콘텐츠에서 지정된 유형의 하위 요소를 검색합니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
elementType | ElementType | 검색할 요소 유형 |
Return
RangeElement
— 검색 요소의 위치를 나타내는 검색결과
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
지정된 RangeElement
에서 시작하여 지정된 유형의 하위 요소를 요소의 내용에서 검색합니다.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().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 | 검색할 검색결과 |
Return
RangeElement
— 검색 요소의 다음 위치를 나타내는 검색결과
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
정규 표현식을 사용하여 지정된 텍스트 패턴의 요소 콘텐츠를 검색합니다.
자바스크립트 정규 표현식 기능의 하위 집합(예: 캡처 그룹 및 모드 수정자)은 완전히 지원되지 않습니다.
제공된 정규 표현식 패턴은 현재 요소에 포함된 각 텍스트 블록과 독립적으로 일치합니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
searchPattern | String | 검색할 패턴 |
Return
RangeElement
— 검색 텍스트의 위치를 나타내는 검색결과 또는 일치하는 항목이 없는 경우 null
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
지정된 검색결과부터 요소의 텍스트 콘텐츠를 지정된 텍스트 패턴으로 검색합니다.
자바스크립트 정규 표현식 기능의 하위 집합(예: 캡처 그룹 및 모드 수정자)은 완전히 지원되지 않습니다.
제공된 정규 표현식 패턴은 현재 요소에 포함된 각 텍스트 블록과 독립적으로 일치합니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
searchPattern | String | 검색할 패턴 |
from | RangeElement | 검색할 검색결과 |
Return
RangeElement
— 검색 텍스트의 다음 위치를 나타내는 검색결과 또는 일치하는 항목이 없는 경우 null
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
요소의 속성을 검색합니다.
결과는 유효한 각 요소 속성에 대한 속성을 포함하는 객체입니다. 여기서 각 속성 이름은 DocumentApp.Attribute
열거형의 항목에 해당합니다.
var body = DocumentApp.getActiveDocument().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]); }
Return
Object
— 요소의 속성입니다.
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
지정된 하위 색인에서 하위 요소를 검색합니다.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. 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 | 검색할 하위 요소의 색인 |
Return
Element
: 지정된 색인의 하위 요소
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
getLinkUrl()
링크 URL을 검색합니다.
Return
String
: 링크 URL 또는 요소에 이 속성의 값이 여러 개 포함된 경우 null
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
getNumChildren()
하위 요소의 수를 검색합니다.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
Return
Integer
— 하위 요소 수
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
요소의 상위 요소를 검색합니다.
상위 요소에 현재 요소가 포함되어 있습니다.
Return
ContainerElement
: 상위 요소입니다.
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
getText()
요소의 내용을 텍스트 문자열로 검색합니다.
Return
String
: 요소의 콘텐츠(텍스트 문자열)입니다.
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
텍스트 정렬을 가져옵니다. 사용 가능한 정렬 유형은 DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
, DocumentApp.TextAlignment.SUPERSCRIPT
입니다.
Return
TextAlignment
: 텍스트 정렬 유형 또는 텍스트에 여러 유형의 텍스트 정렬이 포함되어 있거나 텍스트 정렬이 설정되지 않은 경우 null
입니다.
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
요소의 ElementType
를 검색합니다.
getType()
를 사용하여 특정 요소의 정확한 유형을 확인합니다.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document 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.'); }
Return
ElementType
: 요소 유형입니다.
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
merge()
요소를 동일한 유형의 선행 동위와 병합합니다.
동일한 ElementType
의 요소만 병합할 수 있습니다. 현재 요소에 포함된 하위 요소는 모두 이전 동위 요소로 이동합니다.
현재 요소가 문서에서 삭제됩니다.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Return
ContainerElement
— 병합된 요소입니다.
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
상위 요소로부터 요소를 삭제합니다.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Return
ContainerElement
— 삭제된 요소입니다.
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
정규 표현식을 사용하여 지정된 텍스트 패턴의 모든 항목을 지정된 대체 문자열로 바꿉니다.
검색 패턴은 자바스크립트 정규 표현식 객체가 아닌 문자열로 전달됩니다. 따라서 이 패턴에서는 백슬래시를 이스케이프 처리해야 합니다.
이 메서드는 지원되는 구문을 제한하는 Google의 RE2 정규 표현식 라이브러리를 사용합니다.
제공된 정규 표현식 패턴은 현재 요소에 포함된 각 텍스트 블록과 독립적으로 일치합니다.
var body = DocumentApp.getActiveDocument().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
매개변수
이름 | 유형 | 설명 |
---|---|---|
searchPattern | String | 검색할 정규 표현식 패턴 |
replacement | String | 대체용으로 사용할 텍스트 |
Return
Element
: 현재 요소
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
요소의 속성을 설정합니다.
지정된 속성 매개변수는 각 속성 이름이 DocumentApp.Attribute
열거형 항목이며 각 속성 값이 적용할 새 값인 객체여야 합니다.
var body = DocumentApp.getActiveDocument().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 | 요소의 속성입니다. |
Return
ContainerElement
: 현재 요소입니다.
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
링크 URL을 설정합니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
url | String | 링크 URL |
Return
ContainerElement
: 현재 요소
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
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 be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
매개변수
이름 | 유형 | 설명 |
---|---|---|
textAlignment | TextAlignment | 적용할 텍스트 정렬 유형 |
Return
ContainerElement
: 현재 요소
승인
이 방법을 사용하는 스크립트에는 다음 범위 중 하나 이상을 사용하여 승인해야 합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents